Get project contacts

GET

/projects/{id}/contacts

const url = 'https://agent-dev.azizdubai.com/projects/1/contacts';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

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://agent-dev.azizdubai.com/projects/1/contacts \
  --header 'X-API-Key: <X-API-Key>'

Returns the owning company and its staff with their profiles. Users with the ceo role are excluded from public contacts.

Authorizations

apiKeyHeader
bearerKey

Parameters

Path Parameters

required

integer

>= 1

Project ID.

Responses

200

Project contacts.

application/json

object

status

required

string

Allowed value: success

data

required

The shape depends on the operation.

data

required

object

company

object

integer

name

string

avatar

Ready-to-use link to the company logo.

string | null

workers

Array<object>

object

user_id

integer

name

string

email

string

role

Legacy free-form string: broker, manager, … The ceo role is excluded.

string

avatar

string | null

contact_phone

string | null

social_links

One of:

object
null

Social media links from the staff member’s profile.

object

telegram

string

instagram

string

linkedin

string

facebook

string

twitter

string

whatsapp

string

website

string

languages

Array<string> | null

bio

string | null

Example

{
  "status": "success",
  "data": {
    "workers": [
      {
        "languages": [
          "en",
          "ru",
          "ar"
        ]
      }
    ]
  }
}

400

A parameter or the request body failed validation.

application/json

object

status

required

string

Allowed value: error

message

required

Human-readable message.

string

Examples

badID

{
  "status": "error",
  "message": "id must be a positive integer"
}

401

The key is missing (missing api key) or invalid (invalid api key). The latter covers unknown, revoked and deleted keys. Every operation requires a key, so any request without one receives this response.

application/json

object

status

required

string

Allowed value: error

message

required

Human-readable message.

string

Examples

invalid

{
  "status": "error",
  "message": "invalid api key"
}

403

The key is valid, but it is restricted to a list of domains and the request’s Origin (or Referer) does not match any of them; or the key’s agency has no approved licence.

application/json

object

status

required

string

Allowed value: error

message

required

Human-readable message.

string

Examples

{
  "status": "error",
  "message": "origin is not allowed for this api key"
}

{
  "status": "error",
  "message": "agency license is required: upload a company license and wait for its approval"
}

404

No record exists with the given ID — or it belongs to a developer the key’s agency has no approved contract with.

application/json

object

status

required

string

Allowed value: error

message

required

Human-readable message.

string

Examples

unit

{
  "status": "error",
  "message": "unit not found"
}

500

An unexpected error. The cause is logged; a generic message is returned.

application/json

object

status

required

string

Allowed value: error

message

required

Human-readable message.

string

Examples

generic

{
  "status": "error",
  "message": "internal server error"
}