List scopes

GET

/api/v1/scopes

const url = 'https://app.prokure.ca/api/v1/scopes';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.prokure.ca/api/v1/scopes

Responses

200

Default Response

application/json

object

scopes

required

Array<object>

object

value

required

string

Allowed values: opportunities:read opportunities:write profile:read profile:write settings:read settings:write dashboard:read

label

required

string

description

required

string

Example

{
  "scopes": [
    {
      "value": "opportunities:read"
    }
  ]
}

500

Default Response

application/json

object

error

required

string

Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal

message

required

string

requestId

required

string

issues

Array

issue_count

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "error": "unauthorized"
}