v1
latestOpenAPI 3.0.02026-07-26392662.9 KBContacts
Get contacts for an organisation
get/v1/workspaces/{workspaceUuid}/contacts
Path parameters
workspaceUuidstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000
The UUID of the workspace
Query parameters
domainstring
Example:pirateinc.com
Either organisation_uuid or domain must be provided
organisation_uuidstring uuid
Example:550e8400-e29b-41d4-a716-446655440000
Either organisation_uuid or domain must be provided
pageinteger
Example:1
The page number for pagination
sizeinteger
Example:10
The number of organisations per page (1-1000)
Response
A paginated list of the contacts
Example response
{
"current_page": 1,
"last_page": 10,
"per_page": 15,
"total": 150,
"next_page_url": "https://api.example.com/v1/workspaces?page=2",
"first_page_url": "https://api.example.com/v1/workspaces?page=1",
"last_page_url": "https://api.example.com/v1/workspaces?page=10",
"path": "https://api.example.com/v1/workspaces",
"from": 1,
"to": 15,
"data": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"email": "john@pirateinc.com",
"first_name": "John",
"last_name": "Doe",
"position": "CEO",
"headline": "CEO at Pirate Inc.",
"department": [
"IT"
],
"seniority": "Senior",
"linkedin_url": "https://linkedin.com/in/johndoe",
"location": {
"city": "Amsterdam",
"state": "North Holland",
"country": "Netherlands",
"country_code": "NL"
},
"profiles": [
{
"name": "Twitter",
"handle": "@pirateinc",
"url": "https://twitter.com/pirateinc"
}
]
}
],
"success": true
}