### Example Response for Get All Users Source: https://docs.opentoclose.com/ This JSON structure represents a successful response when fetching all users. It includes user ID, first name, last name, email, and full name. ```json [ { "id": 1, "first_name": "Mary", "last_name": "Realtor", "email": "mary@test.com", "name": "Mary Realtor" }, { "id": 2, "first_name": "Joe", "last_name": "Agent", "email": "joe_agent@test.com", "name": "Joe Agent" } ] ``` -------------------------------- ### Example Response for Get All Tags Source: https://docs.opentoclose.com/ This is an example of the JSON response when successfully retrieving all tags. The response includes tag ID, title, category, and color. ```json [ { "id": 1, "title": "Contract", "category": "document", "color": "red" }, { "id": 2, "title": "Appraisal", "category": "task", "color": "null" } ] ``` -------------------------------- ### Get All Users Source: https://docs.opentoclose.com/ Use this endpoint to retrieve a list of all users. Authorization is handled via API Key. ```bash curl --location 'https://api.opentoclose.com/v1/users/' ``` -------------------------------- ### API Token Authentication Example Source: https://docs.opentoclose.com/ Pass your API Token in the query string of each request to authenticate. ```cURL https://api.opentoclose.com/v1/some/api/endpoint?api_token=your_token ``` -------------------------------- ### Get All Tags Source: https://docs.opentoclose.com/ Use this endpoint to retrieve a list of all available tags. Requires an API Key for authorization. ```bash curl --location 'https://api.opentoclose.com/v1/tags' ``` -------------------------------- ### GET /v1/tags Source: https://docs.opentoclose.com/ Retrieves a list of all tags available in the system. This endpoint is useful for fetching tag data for display or filtering purposes. ```APIDOC ## GET /v1/tags ### Description Retrieves a list of all tags available in the system. This endpoint is useful for fetching tag data for display or filtering purposes. ### Method GET ### Endpoint https://api.opentoclose.com/v1/tags ### Parameters ### Request Example ```curl curl --location 'https://api.opentoclose.com/v1/tags' ``` ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the tag. - **title** (string) - The name of the tag. - **category** (string) - The category the tag belongs to. - **color** (string) - The color associated with the tag. #### Response Example ```json [ { "id": 1, "title": "Contract", "category": "document", "color": "red" }, { "id": 2, "title": "Appraisal", "category": "task", "color": null } ] ``` ``` -------------------------------- ### GET /v1/users Source: https://docs.opentoclose.com/ Retrieves a list of all users (agents) in the system. This endpoint is useful for managing user data or displaying user information. ```APIDOC ## GET /v1/users ### Description Retrieves a list of all users (agents) in the system. This endpoint is useful for managing user data or displaying user information. ### Method GET ### Endpoint https://api.opentoclose.com/v1/users ### Parameters ### Request Example ```curl curl --location 'https://api.opentoclose.com/v1/users/' ``` ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the user. - **first_name** (string) - The first name of the user. - **last_name** (string) - The last name of the user. - **email** (string) - The email address of the user. - **name** (string) - The full name of the user. #### Response Example ```json [ { "id": 1, "first_name": "Mary", "last_name": "Realtor", "email": "mary@test.com", "name": "Mary Realtor" }, { "id": 2, "first_name": "Joe", "last_name": "Agent", "email": "joe_agent@test.com", "name": "Joe Agent" } ] ``` ``` -------------------------------- ### GET Time Zones Source: https://docs.opentoclose.com/ Retrieves a list of all available time zones supported by the API. This endpoint can be used with pagination and sorting parameters. ```APIDOC ## GET /v1/timeZones ### Description Get all Time Zones. This endpoint supports pagination and searching. ### Method GET ### Endpoint https://api.opentoclose.com/v1/timeZones ### Parameters #### Query Parameters - **api_token** (string) - Required - API key for authentication. - **offset** (integer) - Optional - The number of results to skip. Defaults to 0. - **limit** (integer) - Optional - The maximum number of results to return. Defaults to 20, maximum 100. - **sort_by** (string) - Optional - The field to sort the results by. Varies by endpoint. - **sort_dir** (string) - Optional - The direction to sort the results ('asc' or 'desc'). Defaults to 'asc'. ### Request Example ``` curl --location 'https://api.opentoclose.com/v1/timeZones' ``` ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the time zone. - **country_code** (string) - The country code associated with the time zone. - **country_zone** (string) - The name of the time zone. - **zone_abbreviation** (string) - The abbreviation for the time zone. #### Response Example ```json [ { "id": 112, "country_code": "Not Defined", "country_zone": "Pacific/Fiji", "zone_abbreviation": "+12" } ] ``` ``` -------------------------------- ### Get All Time Zones Source: https://docs.opentoclose.com/ This snippet demonstrates how to retrieve all available time zones from the API using a cURL request. Ensure you have the correct API endpoint. ```curl curl --location 'https://api.opentoclose.com/v1/timeZones' ``` -------------------------------- ### Authentication Source: https://docs.opentoclose.com/ Authentication is handled via API Tokens. Generate your token in the Open To Close web application and pass it in the query string of each request. ```APIDOC ## Authentication ### Description API requests are authenticated using API Tokens. Obtain your token from the Open To Close web application under the Apps & API Dashboard. ### Method GET (or any other method) ### Endpoint `https://api.opentoclose.com/v1/some/api/endpoint?api_token=your_token` ### Parameters #### Query Parameters - **api_token** (string) - Required - Your API token for authentication. ``` -------------------------------- ### HTTP Responses Source: https://docs.opentoclose.com/ Details on successful and unsuccessful HTTP responses, including status codes and error formats. ```APIDOC ## HTTP Responses ### Description Successful requests return a `200 OK` status code with JSON data. Unsuccessful requests return a 4xx status code with a JSON object containing an "error" key. ### Success Response (200) - **data** (object) - The JSON data returned upon successful request. ### Error Responses - **400 Bad Request**: Malformed request. - **401 Unauthorized**: Authenticated but not authorized. - **403 Forbidden**: Not authenticated. - **404 Not Found**: Requested resource not found. - **429 Too Many Requests**: Rate limit exceeded. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.