GET: Collaboration Registration Forms

Ingrid

https://api.bitsighttech.com/ratings/v1/client-access-links

View your registration forms for clients to register for the Client/Vendor Access Program.

Example Request

curl https://api.bitsighttech.com/ratings/v1/client-access-links -u api_token:

Example Response

{
  "links": {
    "next": null,
    "previous": null
  },
  "count": 1,
  "results": [
    {
      "guid": "19caa9ab-0560-4661-9d02-3364b13714ec",
      "link": "https://service.bitsighttech.com/app/static/pages/access-request?token=19caa9ab-0560-4661-9d02-3364b13714ec",
      "name": null,
      "description": null,
      "is_active": true,
      "created_time": "2024-01-29T11:32:20.094183Z",
      "updated_time": "2024-01-29T13:36:10.828123Z",
      "created_by": {
        "guid": "de5750f0-f60b-4478-9bfc-08m20e71f4b2",
        "formal_name": "User one"
      },
      "updated_by": {
        "guid": "de4750f0-f60z-3478-9bfc-08f20e71e4b2",
        "formal_name": "User Two"
      }
    }
  ]
}

Response Attributes

Field				Description
links Object				Navigation for multiple pages of results. See pagination.
	next String			The URL for navigating to the next page of results.
	previous String			The URL for navigating to the previous page of results.
count Integer				The number of forms.
results Array				Forms and their details.
	Object			A form.
		guid String [`collab_form_guid`]		The unique identifier of this collaboration registration form.
		link String		The form URL.
		name String		The name of this form.
		description String		A description of this form.
		is_active Boolean		`true` = This form is active.
		created_time String [`YYYY-MM-DDTHH:MM:SSZ`]		The date and time when this form was created.
		updated_time String [`YYYY-MM-DDTHH:MM:SSZ`]		The date and time when this form was last updated.
		created_by Object		The user who created this form.
			guid String [`user_guid`]	This user’s unique identifier.
			formal_name String	This user's name.
		updated_by Object		The user who last updated this form.
			guid String [`user_guid`]	This user’s unique identifier.
			formal_name String	This user's name.

Status Codes

See the common errors and status codes.

200 – Okay: Everything worked as expected.
401 – No Authentication: No valid API token was provided.
403 – Unauthorized: You do not have permission to access this resource.
404 – Not Found: The specified resource could not be found.

February 12, 2024: Published.