Organisations
Get an organisation
Organisations
Get an organisation
GET
/
api
/
v1
/
workspaces
/
{workspaceUuid}
/
organisations
/
{organisationUuid}
curl --request GET \
--url https://app.snitcher.com/api/v1/workspaces/{workspaceUuid}/organisations/{organisationUuid} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"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": {
"country": "US",
"state": "California",
"city": "Los Angeles",
"latitude": 34.0522,
"longitude": -118.2437,
"street": "Hollywood Blvd",
"street_number": "123",
"postal_code": "90028",
"address": "Hollywood Blvd 123",
"full_address": "Hollywood Blvd 123, Los Angeles, California, US"
},
"founded": 2000,
"size": "1-10",
"industry": "Piracy",
"phone": "+1 123 456 7890",
"email": "john@example.org",
"profiles": [
{
"name": "Twitter",
"handle": "@pirateinc",
"url": "https://twitter.com/pirateinc"
}
],
"tags": [
"Customer"
],
"segments": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Hot leads"
}
]
}
}
Authorizations
Enter your personal access token (PAT) to authenticate
Path Parameters
The UUID of the workspace
Example:
"550e8400-e29b-41d4-a716-446655440000"
The UUID of the organisation
Example:
"550e8400-e29b-41d4-a716-446655440000"
Response
200 - application/json
The organisation
Example:
true
Representation of an organisation
Maps an Organisation object to an API response.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Example:
"Pirate Inc."
Example:
"https://pirateinc.com"
Example:
"2021-01-01T00:00:00Z"
Example:
"2021-01-01T00:00:00Z"
Example:
"https://pirateinc.com/logo.png"
Representation of an address in API responses
Maps an Organisation object to an API response.
Example:
"US"
Example:
"California"
Example:
"Los Angeles"
Example:
34.0522
Example:
-118.2437
Example:
"Hollywood Blvd"
Example:
"123"
Example:
"90028"
Example:
"Hollywood Blvd 123"
Example:
"Hollywood Blvd 123, Los Angeles, California, US"
Example:
2000
Example:
"1-10"
Example:
"Piracy"
Example:
"+1 123 456 7890"
Example:
"john@example.org"
curl --request GET \
--url https://app.snitcher.com/api/v1/workspaces/{workspaceUuid}/organisations/{organisationUuid} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"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": {
"country": "US",
"state": "California",
"city": "Los Angeles",
"latitude": 34.0522,
"longitude": -118.2437,
"street": "Hollywood Blvd",
"street_number": "123",
"postal_code": "90028",
"address": "Hollywood Blvd 123",
"full_address": "Hollywood Blvd 123, Los Angeles, California, US"
},
"founded": 2000,
"size": "1-10",
"industry": "Piracy",
"phone": "+1 123 456 7890",
"email": "john@example.org",
"profiles": [
{
"name": "Twitter",
"handle": "@pirateinc",
"url": "https://twitter.com/pirateinc"
}
],
"tags": [
"Customer"
],
"segments": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Hot leads"
}
]
}
}