Skip to content
digizeDocs

Get a company

GET
/api/v1/companies/{id}
curl --request GET \
  --url https://digize.com/api/v1/companies/example \
  --header 'x-api-key: <x-api-key>'

One company with its people, orders and its five latest orders.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
id
required
string
name
required
string
domain
required
string | null
industry
required
string | null
city
required
string | null
ownerId
required
string | null
createdAt
required
string format: date-time
status
required
string
Allowed values: active lapsed prospect
people
required
Array<object>
object
id
required
string
name
required
string
email
required
string | null
stage
required
string
Allowed values: lead customer repeat
lifetimeValue
required
number
orders
required
number
totalSpent
required
number
lastOrderAt
required
Any of:
string format: date-time
recentOrders
required
Array<object>
object
id
required
string
number
required
number
customerName
required
string
placedAt
required
string format: date-time
total
required
number

Example 

{
  "status": "active",
  "people": [
    {
      "stage": "lead"
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}