GET
/
api
/
v1
/
profile_externals
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "organisation": "<string>",
      "role": "<string>",
      "twitter": "<string>",
      "linkedin": "<string>",
      "instagram": "<string>",
      "country": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "isNewsletterSubscribed": true,
      "stripeCustomerId": "<string>",
      "town": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "country": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "name": "<string>"
        }
      },
      "dateCreated": "2023-11-07T05:31:56Z",
      "isValidatedIdentity": true,
      "isValidatedIdentityPending": true,
      "identity": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "isValidated": true,
        "hasUploadedDocument": true,
        "idAddress": "<string>",
        "status": "<string>",
        "addressStreet": "<string>",
        "addressDetails": "<string>"
      },
      "localCenter": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "product": "https://example.com/",
      "companyIdentifier": "<string>",
      "companyName": "<string>",
      "companyAddress": "<string>",
      "customFieldValues": [
        "https://example.com/"
      ],
      "professionOrganisationRole": "<string>",
      "companyRegNo": "<string>",
      "status": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "color": "<string>",
        "position": 123
      },
      "lastStatusUpdate": "2023-11-07T05:31:56Z",
      "fullName": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

page
integer
default:1

The collection page number

pagination
boolean

Enable or disable pagination

name
string
email
string
email[]
string[]
town
string
town[]
string[]
country
string
country[]
string[]
isNewsletterSubscribed
boolean
isNewsletterSubscribed[]
boolean[]
customFieldValues
string
customFieldValues[]
string[]
status
string
status[]
string[]
order[isNewsletterSubscribed]
enum<string>
default:asc
Available options:
asc,
desc
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc

Response

200
application/ld+json

ProfileExternal collection

The response is of type object.