v1
latestOpenAPI 3.0.02026-07-26392662.9 KBOrganisations
List organisations
get/v1/workspaces/{workspaceUuid}/organisations
Path parameters
workspaceUuidstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000
The UUID of the workspace
Query parameters
segmentUuidstring uuid
Example:550e8400-e29b-41d4-a716-446655440000
Optional segment UUID for filtering organisations
pageinteger
Example:1
The page number for pagination
sizeinteger
Example:10
The number of organisations per page (1-1000)
datestring date
Example:2025-03-01
The specific date to filter organisations that visited that day.
date_fromstring date
Example:2025-03-01
The start date for filtering organisations based on visits. Can only be used if date is not provided.
date_tostring date
Example:2025-03-10
The end date for filtering organisations based on visits. Can only be used if date is not provided.
namestring
Example:Pirate
Filters organisations where the name contains the given string.
Response
A paginated list of organisations
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",
"name": "Pirate Inc.",
"website": "https://pirateinc.com",
"first_seen": "2021-01-01T00:00:00Z",
"last_seen": "2021-01-01T00:00:00Z",
"logo": "https://pirateinc.com/logo.png",
"address": {
"street": "Hollywood Blvd",
"street_number": "123",
"postal_code": "90028",
"address": "Hollywood Blvd 123",
"full_address": "Hollywood Blvd 123, Los Angeles, California, US",
"city": "Los Angeles",
"state": "California",
"country": "US"
},
"industry": "Piracy",
"phone": "+49 123 4567890",
"email": "john@example.org",
"profiles": [
{
"name": "Twitter",
"handle": "@pirateinc",
"url": "https://twitter.com/pirateinc"
}
],
"segments": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Hot leads"
}
],
"total_pageviews": 42,
"total_time_on_site": "1:02:05",
"visitor_locations": [
"Amsterdam, NL"
]
}
],
"success": true
}