List segments

List segments

curl --request GET \
  --url https://api.quartr.com/public/v3/companies/{id}/segments \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "companyId": 4742,
      "createdAt": "2025-04-15T15:00:00.000Z",
      "updatedAt": "2025-04-15T15:00:00.000Z",
      "fiscalYear": 2024,
      "reportDate": "2025-03-19T15:00:00.000Z",
      "segmentItem": "Revenue",
      "segmentCategory": "Business Area",
      "total": 187442,
      "totalUnit": "MUSD",
      "other": "1.0 (0.0%)",
      "items": [
        {
          "name": "Automotive",
          "value": 171605
        },
        {
          "name": "GM Financial",
          "value": 15875
        },
        {
          "name": "Cruise",
          "value": 257
        },
        {
          "name": "Eliminations/reclassifications",
          "value": -296
        }
      ],
      "itemUnit": "MUSD"
    }
  ],
  "pagination": {
    "nextCursor": 10
  }
}

GET

public

companies

{id}

segments

List segments

curl --request GET \
  --url https://api.quartr.com/public/v3/companies/{id}/segments \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "companyId": 4742,
      "createdAt": "2025-04-15T15:00:00.000Z",
      "updatedAt": "2025-04-15T15:00:00.000Z",
      "fiscalYear": 2024,
      "reportDate": "2025-03-19T15:00:00.000Z",
      "segmentItem": "Revenue",
      "segmentCategory": "Business Area",
      "total": 187442,
      "totalUnit": "MUSD",
      "other": "1.0 (0.0%)",
      "items": [
        {
          "name": "Automotive",
          "value": 171605
        },
        {
          "name": "GM Financial",
          "value": 15875
        },
        {
          "name": "Cruise",
          "value": 257
        },
        {
          "name": "Eliminations/reclassifications",
          "value": -296
        }
      ],
      "itemUnit": "MUSD"
    }
  ],
  "pagination": {
    "nextCursor": 10
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

number

required

Query Parameters

limit

number

default:10

The maximum number of items to return in a single request.

Required range: 1 <= x <= 500

Example:

10

cursor

number

default:0

A unique identifier pointing to the starting position for the next set of results.

Required range: x >= 0

Example:

2432

direction

enum<string>

default:asc

The direction of the sort order (id field).

Available options:

asc,

desc

Example:

"asc"

Response

data

object[]

required

Show child attributes

data.companyId

number

required

Example:

4742

data.createdAt

string<date-time>

required

Example:

"2025-04-15T15:00:00.000Z"

data.updatedAt

string<date-time>

required

Example:

"2025-04-15T15:00:00.000Z"

data.fiscalYear

number

Example:

2024

data.reportDate

string<date-time>

Example:

"2025-03-19T15:00:00.000Z"

data.segmentItem

string

Example:

"Revenue"

data.segmentCategory

string

Example:

"Business Area"

data.total

number

Example:

187442

data.totalUnit

string

Example:

"MUSD"

data.other

string

Example:

"1.0 (0.0%)"

data.items

object[]

Show child attributes

data.items.name

string

Example:

"Automotive"

data.items.value

number

Example:

171605

Example:

[
  { "name": "Automotive", "value": 171605 },
  { "name": "GM Financial", "value": 15875 },
  { "name": "Cruise", "value": 257 },
  {
    "name": "Eliminations/reclassifications",
    "value": -296
  }
]

data.itemUnit

string

Example:

"MUSD"

pagination

object

required

Show child attributes

pagination.nextCursor

number | null

required

A unique identifier indicating the position to continue fetching the next set of results in subsequent requests.

Example:

10

Retrieve a company List events

⌘I

Companies

Events

Event Types

Documents

Reports

Slides

Transcripts

Document Types

Backlog Audio

Live

Live Audio

Live Transcripts

Authorizations

Path Parameters

Query Parameters

Response