Skip to main content
GET
/
v1
/
custom-fields
/
companies
Get company custom field definitions
curl --request GET \
  --url https://api.stardex.ai/v1/custom-fields/companies \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Seniority Level",
      "description": "Candidate seniority classification",
      "data_type": "single-select",
      "job_id": null,
      "list_id": null,
      "tags": [
        {
          "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
          "name": "Junior",
          "color": "#86efac",
          "description": null
        },
        {
          "id": "f2e3d4c5-b6a7-8901-bcde-f12345678901",
          "name": "Mid",
          "color": "#93c5fd",
          "description": null
        },
        {
          "id": "f3e4d5c6-b7a8-9012-cdef-g12345678902",
          "name": "Senior",
          "color": "#d8b4fe",
          "description": null
        }
      ]
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Tags",
      "description": "General-purpose tags for categorization",
      "data_type": "multi-select",
      "job_id": null,
      "list_id": null,
      "tags": [
        {
          "id": "a1b2c3d4-1234-5678-9abc-def012345678",
          "name": "Banking",
          "color": "#fde68a",
          "description": null
        },
        {
          "id": "a2b3c4d5-2345-6789-0abc-def123456789",
          "name": "Fintech",
          "color": "#a5f3fc",
          "description": null
        },
        {
          "id": "a3b4c5d6-3456-7890-1abc-def234567890",
          "name": "Referred",
          "color": "#fca5a5",
          "description": null
        }
      ]
    },
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "Years of Experience",
      "description": "Total years of professional experience",
      "data_type": "integer",
      "job_id": null,
      "list_id": null,
      "tags": []
    },
    {
      "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "name": "Available From",
      "description": "Earliest start date",
      "data_type": "date",
      "job_id": null,
      "list_id": null,
      "tags": []
    },
    {
      "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "name": "Stage Rating",
      "description": "Candidate rating for this specific job",
      "data_type": "single-select",
      "job_id": "11223344-5566-7788-99aa-bbccddeeff00",
      "list_id": null,
      "tags": [
        {
          "id": "b1c2d3e4-5678-9012-abcd-ef0123456789",
          "name": "A",
          "color": "#86efac",
          "description": null
        },
        {
          "id": "b2c3d4e5-6789-0123-bcde-f01234567890",
          "name": "B",
          "color": "#fde68a",
          "description": null
        },
        {
          "id": "b3c4d5e6-7890-1234-cdef-012345678901",
          "name": "C",
          "color": "#fca5a5",
          "description": null
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.stardex.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Query Parameters

​
is_client
boolean

Filter definitions by client/non-client company type.

​
job_id
string<uuid>

Job UUID. When provided, returns global company attributes PLUS job-specific attributes for this job. Without this parameter, only global company attributes are returned.

​
list_id
string<uuid>

List UUID. When provided, returns global company attributes PLUS list-specific attributes for this list. Without this parameter, only global company attributes are returned.

Response

Custom field definitions fetched

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required