CHchrt
/orgs
/orgs/org_public_data

Get public data

Changed on

Retrieves public organization data for the caller's organization. | () -> (OrgPublicData1)

get/orgs/org_public_data/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/orgs/org_public_data/v1
  • Auth
    HTTP bearer

Response

Successful Response

schema_version1 required
namestring required
descriptionstring nullable
handlestring nullable

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

industrystring nullable
email_addressstring nullable
phone_numberstring phone nullable
org_type'provider' | 'shipper' | 'vendor' required
org_idstring required

Must be a string starting with org_

org_public_data_s3_object_metadata_idsstring[]
_idstring required

Changes

  • 5e62049a1c19Revision changes
    • info

      added the optional property to the response with the status