Sample Call

A sample curl call to the fictional /dictionary-term/2 endpoint would look like (with <YOUR TOKEN HERE> being replaced by the actual access token):

GET /my-account

curl -X GET --header "Accept: application/vnd.ucf.v1+json" --header "Authorization: Bearer <YOUR TOKEN HERE>" "https://api.unifiedcompliance.com/my-account"

response /my-account 

{
    "account": {
        "address1": "244 Lafayette Circle",
        "address2": "",
        "allowed_builds": 0,
        "city": "Lafayette",
        "country": "US",
        "date_created": "2015-03-12",
        "date_updated": "2016-07-15",
        "domain": "unifiedcompliance",
        "groups": {
        },
        "hide_organization_name": "n",
        "id": 25,
        "initiatives": {
        },
        "logo": "",
        "organization_name": "Network Frontiers",
        "postal_code": "94549",
        "roles": {
        },
        "select_ads": 0,
        "show_implementation": true,
        "state": "CA",
        "status": "active",
        "time_created": "2015-03-12T22:46:18+0000",
        "time_updated": "2016-07-15T12:33:51+0000",
        "unspsc_code": "",
        "users": {
        }
    },
    "ad_lists": [
        {
            "_href": "https://api.unifiedcompliance.com/cch-ad-list/3781",
            "active_status": "A",
            "authority_documents": {
            },
            "check_digit": 1,
            "creator": {
                "_href": "https://api.unifiedcompliance.com/cch-user/236",
                "id": 236
            },
            "date_created": "2016-05-13",
            "date_updated": "2016-05-13",
            "groups": {
                "_href": "https://api.unifiedcompliance.com/cch-ad-list/3781/groups"
            },
            "id": 3781,
            "initiatives": {
                "_href": "https://api.unifiedcompliance.com/cch-ad-list/3781/initiatives"
            },
            "last_modified_by": {
                "_href": "https://api.unifiedcompliance.com/cch-user/236",
                "id": 236
            },
            "name": "Asia Attestation",
            "outofdate": "0",
            "publish": "n",
            "publish_ident": null,
            "publish_status": "n",
            "time_created": "2016-05-13T12:27:37+0000",
            "time_updated": "2016-05-13T12:27:37+0000",
            "tracked_controls": {
            },
            "users": {
                "_href": "https://api.unifiedcompliance.com/cch-ad-list/3781/users"
            },
            "whitebox_share": "n"
        }
    ],
    "users": [
        {
            "_href": "https://api.unifiedcompliance.com/cch-user/38",
            "account": {
                "_href": "https://api.unifiedcompliance.com/cch-account/25",
                "id": 25
            },
            "active_status": "A",
            "ad_lists": {
                "_href": "https://api.unifiedcompliance.com/cch-user/38/ad-lists"
            },
            "ad_lists_created": {
                "_href": "https://api.unifiedcompliance.com/cch-user/38/ad-lists-created"
            },
            "address1": "244 Lafayette Circle",
            "address2": "",
            "check_digit": 6,
            "city": "Lafayette",
            "country": "US",
            "date_created": "2015-03-12",
            "date_updated": "2016-07-06",
            "email": "dcougias@unifiedcompliance.com",
            "first_name": "Dorian",
            "groups": {
                "_href": "https://api.unifiedcompliance.com/cch-user/38/groups"
            },
            "groups_created": {
                "_href": "https://api.unifiedcompliance.com/cch-user/38/groups-created"
            },
            "id": 38,
            "initiatives": {
                "_href": "https://api.unifiedcompliance.com/cch-user/38/initiatives"
            },
            "initiatives_created": {
            },
            "invited_by": {
                "_href": "https://api.unifiedcompliance.com/cch-user/256",
                "id": 256
            },
            "job_title": "",
            "last_login": "2016-01-17 20:27:20",
            "last_name": "Cougias",
            "phone": "",
            "postal_code": "94549",
            "profile_picture": "",
            "state": "CA",
            "status": 1,
            "time_created": "2015-03-12T22:46:30+0000",
            "time_updated": "2016-07-06T14:28:13+0000",
            "type": "U"
        }
    ]
}

Rate Limiting

The API is rate limited by IP and account. If a rate limit is breached, the following headers and message will be returned (X-RateLimit-Limit header will vary):

Headers:

X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 0

Response:

{
    "message":"API rate limit exceeded"
}

Cors

Cross origin resource sharing is enabled for the API so proper CORS requests can be made from other domains.
The methods supported are:

  • POST
  • GET
  • OPTIONS
  • PUT
  • PATCH
  • OPTIONS

And the headers supported are:

  • Content-Type
  • Authorization
  • Accept
  • Accept-Encoding

GZIP

To enable gzip compression, send an Accept-Encoding: gzip header as part of your request.

Have more questions? Submit a request

Comments

Powered by Zendesk