List contacts linked to a board

GET

/boards/{board}/link/contacts

const url = 'https://projects.work.optidata.cloud/api/boards/1/link/contacts';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://projects.work.optidata.cloud/api/boards/1/link/contacts \
  --header 'Authorization: Bearer <token>'

Returns the Optiwork Contacts records linked to this board, enriched with contact data fetched from the Contacts app.

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

Responses

200

Linked contacts (empty array when none).

application/json

Array<object>

Contact record as provided by the Optiwork Contacts app.

object

key

additional properties

any

Example

[
  {
    "id": 3301,
    "name": "Acme Procurement",
    "email": "procurement@acme.example"
  }
]

401

Missing, invalid or expired bearer passport.

application/json

object

error

string

Example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The authenticated user lacks the required board permission.

application/json

object

message

string

Example

{
  "message": "This action is unauthorized."
}

404

Resource not found, or a nested resource does not belong to its parent in the path.

application/json

object

message

string

Example

{
  "message": "Not found."
}