Retrieve the organization

GET

/api/v1/organization

Returns the organization's balance or monthly allowance, the current price of a report and an interview, and the versions it uses. Read it before spending calls, or pass maxCredits to guard against price changes.

Required scope: organization:read (organization:write also works).

Errors

401: authentication_required, invalid_api_key
403: api_access_disabled, insufficient_scope
429: rate_limit_exceeded
500: api_error
503: service_unavailable

Authorization

ApiKey

headerAuthorizationBearer <probb_live_<id>_<secret>>

Response Body

Success.

application/json

response

object*string

id*string

The organization's ID.

name*string

The organization's name.

billingMode*string

credits organisations pay per report and interview. quota organisations have a monthly allowance.

Value in"credits""quota"

credits*|

Set when billingMode is credits, otherwise null.

quota*|

Set when billingMode is quota, otherwise null.

prices*

Current unit prices for the versions assigned to this organization. Pass maxCredits on spending calls to guard against changes.

versions*

The versions new reports and interviews use.

limits*

Example Request

# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.
curl --fail-with-body -X GET "$PROBB_URL/api/v1/organization" \
  -H "Authorization: Bearer $PROBB_API_KEY"

Example Request

# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/organization" \  -H "Authorization: Bearer $PROBB_API_KEY"

Example ResponseSchema

{
  "object": "organization",
  "id": "string",
  "name": "string",
  "billingMode": "credits",
  "credits": {
    "balance": 0,
    "reserved": 0
  },
  "quota": {
    "periodStart": "2019-08-24T14:15:22Z",
    "periodEnd": "2019-08-24T14:15:22Z",
    "reports": {
      "limit": 0,
      "used": 0,
      "remaining": 0
    },
    "interviews": {
      "limit": 0,
      "used": 0,
      "remaining": 0
    }
  },
  "prices": {
    "report": 0,
    "interview": 0
  },
  "versions": {
    "report": "string",
    "interview": "string"
  },
  "limits": {
    "activeReports": -9007199254740991
  }
}

{  "object": "organization",  "id": "string",  "name": "string",  "billingMode": "credits",  "credits": {    "balance": 0,    "reserved": 0  },  "quota": {    "periodStart": "2019-08-24T14:15:22Z",    "periodEnd": "2019-08-24T14:15:22Z",    "reports": {      "limit": 0,      "used": 0,      "remaining": 0    },    "interviews": {      "limit": 0,      "used": 0,      "remaining": 0    }  },  "prices": {    "report": 0,    "interview": 0  },  "versions": {    "report": "string",    "interview": "string"  },  "limits": {    "activeReports": -9007199254740991  }}

Retrieve the organization

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Response Body