v1

latestOpenAPI 3.0.02026-07-26392662.9 KB

Organisations

Get an organisation

get/v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}

Path parameters

workspaceUuidstring uuid required

Example:550e8400-e29b-41d4-a716-446655440000

The UUID of the workspace

organisationUuidstring uuid required

Example:550e8400-e29b-41d4-a716-446655440000

The UUID of the organisation

Response

The organisation

successboolean

Example response

{
  "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": {
      "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"
    ]
  }
}