Skip to content
Prokure Docs

Get company profile

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

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string
tenant_id
required
string
legal_name
required
string
business_number
required
Any of:
string
cage_code
required
Any of:
string
overview
required
Any of:
string
categories
required
Array<string>
geography
required
Array<string>
certifications
required
Array<string>
exclusions
required
Array<string>
business_role
required
Any of:
string
is_canadian_supplier
required
Any of:
boolean
manufacturer_partners
required
Array<string>
target_buyers
required
Array<string>
min_contract_value
required
Any of:
number
max_contract_value
required
Any of:
number
employee_count
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "id": "example",
  "tenant_id": "example",
  "legal_name": "example",
  "business_number": "example",
  "cage_code": "example",
  "overview": "example",
  "categories": [
    "example"
  ],
  "geography": [
    "example"
  ],
  "certifications": [
    "example"
  ],
  "exclusions": [
    "example"
  ],
  "business_role": "example",
  "is_canadian_supplier": true,
  "manufacturer_partners": [
    "example"
  ],
  "target_buyers": [
    "example"
  ],
  "min_contract_value": 1,
  "max_contract_value": 1,
  "employee_count": 1
}

401

Section titled “401”

Default Response

Media typeapplication/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"
}

403

Section titled “403”

Default Response

Media typeapplication/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"
}

429

Section titled “429”

Default Response

Media typeapplication/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"
}

500

Section titled “500”

Default Response

Media typeapplication/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"
}