How to Enable APIs

Here’s a step-by-step guide to enable and use APIs in your ContractWorks account, please speak to your Account Manager if you do not see this initially available for your room.

Instructions:

  1. Enable Access for a Specific User:
    1. Go to the Users section in Contractworks
      1. Screen Shot 2023-05-22 at 10.39.30 AM
      2. Find the specific user you want to grant API access to, click on their name.
        1. Screen Shot 2023-05-22 at 10.45.51 AM
      3. Next to API, enable the box to Authorize the User.
        1. Screenshot 2025-02-14 at 8.42.35 AM
  2. Verify Access:
    1. Log in as the user.
    2. Navigate to the Settings page.
    3. Check for the "API Settings" section, where you can manage API tokens.
    4. Screenshot 2025-02-14 at 10.41.42 AM
  3. Generate and Use an API Key
    1. Go to the API Settings section under User Settings.
    2. Click Generate API Key
    3. Screenshot 2025-02-14 at 10.43.38 AM
    4. *Important: The key will only be shown once. Copy and store it securely.
  4. Review the Securedocs API Documentation to find instructions and examples, in addition to the specific endpoints
    1. Screenshot 2025-02-14 at 10.45.22 AM
  5. Use the API Key:
    1. Include the API key as a Bearer Token in the Authorization header for all API requests.
  6. Understand API Usage
    1. API Type: This is a GraphQL API, not a REST API.
      1. GraphQL allows precise queries and is widely adopted by platforms like Shopify and GitHub.
    2. Rate Limiting:
      1. 120 requests per hour per IP address.
        Rate limits apply to all queries and mutations.