POST
/
api
/
v1
/
workspaces
/
{workspaceUuid}
/
organisations
{
  "current_page": 1,
  "last_page": 10,
  "per_page": 15,
  "total": 150,
  "next_page_url": "https://api.example.com/api/v1/workspaces?page=2",
  "prev_page_url": null,
  "first_page_url": "https://api.example.com/api/v1/workspaces?page=1",
  "last_page_url": "https://api.example.com/api/v1/workspaces?page=10",
  "path": "https://api.example.com/api/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": {
        "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"
      ]
    }
  ],
  "success": true
}

Authorizations

​
Authorization
string
header
required

Enter your personal access token (PAT) to authenticate

Path Parameters

​
workspaceUuid
string
required

The UUID of the workspace

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

​
segmentUuid
string

Optional segment UUID for filtering organisations

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
page
integer

The page number for pagination

Example:

1

​
size
integer

The number of organisations per page

Example:

10

Body

application/json
​
filters
object
required

Response

200 - application/json
A paginated list of organisations
​
current_page
integer
Example:

1

​
last_page
integer
Example:

10

​
per_page
integer
Example:

15

​
total
integer
Example:

150

​
next_page_url
string | null
Example:

"https://api.example.com/api/v1/workspaces?page=2"

​
prev_page_url
string | null
Example:

null

​
first_page_url
string | null
Example:

"https://api.example.com/api/v1/workspaces?page=1"

​
last_page_url
string | null
Example:

"https://api.example.com/api/v1/workspaces?page=10"

​
path
string | null
Example:

"https://api.example.com/api/v1/workspaces"

​
from
integer | null
Example:

1

​
to
integer | null
Example:

15

​
data
object[]

Representation of an organisation

​
success
boolean
Example:

true

List organisationsGet an organisation