GET
/
connectors
/
meta
curl --request GET \
  --url https://api.stackone.com/connectors/meta \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "provider": "hibob",
    "provider_name": "Hibob",
    "category": "hris",
    "active": true,
    "models": {
      "employees": {
        "create": {
          "apiPath": "/unified/hris/employees/:id",
          "input": {
            "defaultFields": [
              {
                "name": "first_name",
                "type": "string"
              }
            ]
          },
          "output": {
            "defaultFields": [
              {
                "name": "id",
                "type": "string"
              }
            ]
          }
        }
      },
      "time_off": {
        "get": {
          "apiPath": "/unified/hris/employees/:id/time_off/:id",
          "output": {
            "defaultFields": [
              {
                "name": "id",
                "type": "string"
              }
            ]
          }
        }
      }
    },
    "resources": {
      "images": {
        "logo_url": "https://app.stackone.com/assets/logos/hibob.png",
        "original_logo_horizontal_url": "https://app.stackone.com/assets/logos/original/hibob_horizontal.png"
      }
    }
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
include
string | null

The comma separated list of data that will be included in the response

Response

200
application/json
The list of connectors meta information was retrieved.
​
provider
string
required

The provider key

Example:

"hibob"

​
provider_name
string
required

The provider human-readable label

Example:

"Hibob"

​
category
enum<string>
required

The provider service category

Available options:
ats,
hris,
hris-legacy,
crm,
iam,
marketing,
lms,
stackone,
documents
Example:

"hris"

​
models
object
required
Example:
{
  "employees": {
    "create": {
      "apiPath": "/unified/hris/employees/:id",
      "input": {
        "defaultFields": [{ "name": "first_name", "type": "string" }]
      },
      "output": {
        "defaultFields": [{ "name": "id", "type": "string" }]
      }
    }
  },
  "time_off": {
    "get": {
      "apiPath": "/unified/hris/employees/:id/time_off/:id",
      "output": {
        "defaultFields": [{ "name": "id", "type": "string" }]
      }
    }
  }
}
​
active
boolean | null

Whether this provider has been enabled on the integrations page for the current project

Example:

true

​
resources
object

Resources for this provider, such as image assets

Example:
{
  "images": {
    "logo_url": "https://app.stackone.com/assets/logos/hibob.png",
    "original_logo_horizontal_url": "https://app.stackone.com/assets/logos/original/hibob_horizontal.png"
  }
}

Was this page helpful?

Suggest edits
Get Connector Meta information for the given provider keyProxy Request