{"info":{"_postman_id":"9d5543a4-164c-462e-a438-d4b544cc48fc","name":"Ferretly External API","description":"

Authentication

Authentication is handled using API Key authentication via an X-Api-Key request header. The API key to use will be provided by Ferretly. The API Key associated with a client can be modified using the refreshApiKey endpoint.

Each API key value is associated with a particular Organization and a particular Subscriber within that Organization (usually the \"org admin\" subscriber). The Subscriber object represents a user who can log into the Ferretly application, and by whom subjects are \"owned\" when created via the API.

Adding a Subject

NOTE: If there is a Ferretly Analyst in the loop, then your system should not use the \"Start Background Check\" endpoint. Rather, the analyst will start the background check via the Ferretly app. Progress webhook calls will operate the same.

\n\n

Relevant endpoints:

Create New Subject

Initiate Background Check

Background Check Status Webhook

When a subject that was added via the API has a background check in-progress,your API can be notified of updates to the progress of the background check. These notifications occur with an HTTP GET request made to the statusUpdateCallbackUrl value associated with your API key.

The request will include three query parameters:

subjectId - The Ferretly-assigned id for the subject (as a Guid value)
status - the current status (enum values below)
externalSystemId - when a subject is created via the API, you can send a value that identifies the subject in your system

If your organization has Ferretly Analyst assistance, the following status values will be used:

public enum BackgroundCheckStatus\n{\n    None,\n    InQueue,\n    InProgress,\n    Redressing,\n    Complete,\n    Redressed,\n    Error\n}\n\n

If your organization is self-service (no Ferretly Analyst assistance), the following status values will be used:

public enum BackgroundCheckStatus\n{\n    None,\n    InQueue,\n    InProgress,\n    Complete,\n    Error\n}\n\n

Note that Error is only used in the event that an error occurred during the background check. If this occurs, please contact Ferretly Support for troubleshooting.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13665914","collectionId":"9d5543a4-164c-462e-a438-d4b544cc48fc","publishedId":"TVmTca9e","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-12-10T02:53:58.000Z"},"item":[{"name":"Subject Management","item":[{"name":"Get Filtered Posts","item":[{"name":"Get Filtered Posts: Positive Sentiment","id":"d52f25c5-e3e5-4551-b8ba-349ea50d32ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/Subjects/{{subjectId}}/filteredPosts?typeFilter=PositiveSentiment","description":"

Gets \"Postitive Sentiment\" posts from the subject's most recently run background check.

This folder contains samples for requesting a list of posts for a subject. If a background check has never been run for the subject, the result will contain an empty array.

There are two endpoints, one for requesting by the Ferretly subject ID property and one for requesting by the \"external system ID\" property.

By subject ID: {{URL}}/Subjects/{{subjectId}}/filteredPosts

By external system ID: {{URL}}/Subjects/{{externalSystemId}}/filteredPostsByExternalId

The endpoints consume two option query parameters: typeFilter and dateFilter.

TypeFilter Values

All - retrieves all posts

NegativeSentiment - retrieves posts whose sentimentFlag is Negative

PositiveSentiment - retrieve posts whose sentimentFlag is Positive

Flagged - retrieve posts that are \"flagged\" in Ferretly

WebNews - retrieve posts whose postType is WebSearch

Tagged - retrieve posts that have been given a \"tag\"

DateFilter Values

None - the post's postDate is ignored

ThirtyDays - only posts having postDate within the last 30 days are returned

SincePrevious - for continuous screening subjects, returns the posts found in the most-recent screening

\n","_postman_id":"60f1a3c5-3fba-42fb-a4f1-baccebc0882b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]},"isInherited":true,"source":{"_postman_id":"9d5543a4-164c-462e-a438-d4b544cc48fc","id":"9d5543a4-164c-462e-a438-d4b544cc48fc","name":"Ferretly External API","type":"collection"}}},{"name":"Create New Subject","id":"48c9d8d2-b25b-4fc8-ad38-d14fefd64a47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"subjectData\": {\r\n \"name\": \"Throckmorton Scribblemonger\",\r\n \"profilePicUrl\": \"https://static.wixstatic.com/media/7b442b_3ac76a7d6b3944baafefef838a04ddbe~mv2.jpg\"\r\n },\r\n \"handles\": [\r\n {\r\n \"platform\":\"Twitter\",\r\n \"handle\":\"realThrockMorton\",\r\n \"profilePicUrl\":\"https://static.wixstatic.com/media/7b442b_3ac76a7d6b3944baafefef838a04ddbe~mv2.jpg\",\r\n \"title\":\"Throckmorton Scribblemonger\",\r\n \"bio\":\"Sample subject to show the power of Ferretly\"\r\n },\r\n {\r\n \"platform\":\"Instagram\",\r\n \"handle\":\"realThrockMorton\",\r\n \"profilePicUrl\":\"https://static.wixstatic.com/media/7b442b_3ac76a7d6b3944baafefef838a04ddbe~mv2.jpg\",\r\n \"title\":\"Throckmorton Scribblemonger\",\r\n \"bio\":\"I'm a fictitious character meant to demonstrate how Ferretly can mitigate employment risk.\"\r\n }\r\n ],\r\n \"assignToFerretlyAnalyst\": false,\r\n \"externalSystemId\": \"Subject1234\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/Subjects","description":"

Creates a new subject. The full Subject model (only Name is required).

The IsDebug property should only be set to true when you are testing your interaction with the API. When this is set to true, the subject will not be created in your organization and will not appear in the Ferretly app.

{\n  \"SubjectData\": {\n    \"Name\": \"string\",\n    \"ProfilePicUrl\": \"string\",  // URL of the subject's profile picture\n    \"Address\": \"string\",\n    \"City\": \"string\",\n    \"State\": \"string\",\n    \"Email\": \"string\",\n    \"HighSchool\": \"string\",\n    \"College\": \"string\",\n    \"Company\": \"string\",\n    \"Phone\": \"string\",\n    \"TwitterUrl\": \"string\",      // URL of the subject's Twitter profile\n    \"FacebookUrl\": \"string\",     // URL of the subject's Facebook profile\n    \"InstagramUrl\": \"string\",    // URL of the subject's Instagram profile\n    \"LinkedInUrl\": \"string\",     // URL of the subject's LinkedIn profile\n    \"TikTokUrl\": \"string\",       // URL of the subject's TikTok profile\n    \"Tags\": [\n      \"string\"\n    ],\n    \"Country\": \"string\",\n    \"AgeOrDateOfBirth\": \"string\"\n  },\n  \"Handles\": [    // specify information about individual social media profiles\n    {\n      \"Platform\": \"string\",\n      \"Handle\": \"string\",\n      \"Verified\": true,\n      \"ProfileUrl\": \"string\",\n      \"ProfilePicUrl\": \"string\",\n      \"Title\": \"string\",\n      \"Location\": \"string\",\n      \"Workplace\": \"string\",\n      \"School\": \"string\",\n      \"LivesIn\": \"string\",\n      \"From\": \"string\",\n      \"FacebookStatus\": \"string\",\n      \"SocialMediaLinkedAccount\": \"string\",\n      \"Joined\": \"2021-04-20T00:12:29.299Z\",\n      \"PostCount\": 0,\n      \"Followers\": 0,\n      \"Following\": 0,\n      \"Bio\": \"string\",\n      \"Status\": 0\n    }\n  ],\n  \"AssignToFerretlyAnalyst\": true,\n  \"ExternalSystemId\": \"string\",\n  \"IsDebug\": true\n}\n\n

","urlObject":{"path":["Subjects"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"48c9d8d2-b25b-4fc8-ad38-d14fefd64a47"},{"name":"Get Subjects","event":[{"listen":"test","script":{"id":"b016ecc9-f96d-4a90-81f5-c390f6ad5915","type":"text/javascript","exec":["var jsonData = JSON.parse(responseBody);\r","if(jsonData.length > 0)\r","{\r"," postman.setEnvironmentVariable(\"subjectId\", jsonData[0].id);\r","}"]}}],"id":"fa46881b-0128-4a12-bba1-4cb1bac10b5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/Subjects","description":"

Get all subjects associated with your API key

Retrieve a Subject using the Ferretly ID value of the subject.

Fetches a particular subject using the ExternalId property value. This value would have been passed to the subject controller's POST method when the subject was created.

NOTE: If your organization has Analyst Support enabled, then this endpoint should not be used.

Initiate a new background check for the specified subject.

Will return BadRequest in the following situations:

The subject is enabled for continuous screening
The subject already has a background check in-progress
The organization does not have enough available credits purchased

If successful, will return Ok(\"InQueue\"). Otherwise, will return Ok(\"Error\")

This endpoint will return the current status of the subject's report. The following values are returned:

InQueue

InProgress

Redressing- when the subject is assigned to a Ferretly analyst and is being redressed.

Complete - the background check report is available for download.

EndFragment##

Potential Values

public enum BackgroundCheckStatus\n{\n    None,\n    InQueue,\n    InProgress,\n    Redressing,\n    Complete,\n    Error\n}\n\n

For a particular subject, get the results of the most-recently-completed background check.

Will return BadRequest if the subject has no completed background checks or currently has a background check in-progress.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]},"isInherited":true,"source":{"_postman_id":"9d5543a4-164c-462e-a438-d4b544cc48fc","id":"9d5543a4-164c-462e-a438-d4b544cc48fc","name":"Ferretly External API","type":"collection"}},"urlObject":{"path":["Subjects","{{subjectId}}","backgroundCheckResults"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"9440b658-1400-471e-af7d-1822e51ee027","name":"Get Background Check Results","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/Subjects/{{subjectId}}/backgroundCheckResults"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 12 Dec 2020 17:50:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"initiated\": \"2020-11-24T00:51:58.634Z\",\n \"subjectId\": \"12367a18-2045-48f0-93f6-31aec3ce4eb1\",\n \"subjectExternalSystemId\": \"\",\n \"riskMakeups\": [\n {\n \"riskName\": \"Political Speech\",\n \"count\": 51\n },\n {\n \"riskName\": \"Hate Speech\",\n \"count\": 0\n },\n {\n \"riskName\": \"Drug-related Images\",\n \"count\": 0\n },\n {\n \"riskName\": \"Explicit/Racy Images\",\n \"count\": 0\n },\n {\n \"riskName\": \"Violent Images\",\n \"count\": 0\n },\n {\n \"riskName\": \"Insults and Bullying\",\n \"count\": 8\n },\n {\n \"riskName\": \"Narcotics\",\n \"count\": 0\n },\n {\n \"riskName\": \"Obscene Language\",\n \"count\": 24\n },\n {\n \"riskName\": \"Self-Harm\",\n \"count\": 0\n },\n {\n \"riskName\": \"Toxic Language\",\n \"count\": 1\n },\n {\n \"riskName\": \"Threat of Violence\",\n \"count\": 0\n },\n {\n \"riskName\": \"Keywords\",\n \"count\": 30\n }\n ],\n \"channelVolumes\": [\n {\n \"channelName\": \"Facebook\",\n \"count\": 0\n },\n {\n \"channelName\": \"Twitter\",\n \"count\": 2226\n },\n {\n \"channelName\": \"Instagram\",\n \"count\": 0\n },\n {\n \"channelName\": \"LinkedIn\",\n \"count\": 0\n }\n ],\n \"flaggedPosts\": 84,\n \"totalPosts\": 2226,\n \"webSearchPosts\": 20,\n \"score\": 207,\n \"totalSentiment\": 78.3589,\n \"finishedScraping\": \"2020-11-24T00:59:55.5572882Z\",\n \"runStatus\": \"RunCompleted\"\n}"}],"_postman_id":"50521718-abef-43e6-b174-359870322a64"},{"name":"Get Background Check Results By Subject's External ID","id":"91abbfd3-b739-48c1-810d-8bf1526bd9e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/Subjects/getByExternalId/{{externalSystemId}}/backgroundCheckResults","description":"

Get the background check results for the subject specified by the externalSystemId value.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]},"isInherited":true,"source":{"_postman_id":"9d5543a4-164c-462e-a438-d4b544cc48fc","id":"9d5543a4-164c-462e-a438-d4b544cc48fc","name":"Ferretly External API","type":"collection"}},"urlObject":{"path":["Subjects","getByExternalId","{{externalSystemId}}","backgroundCheckResults"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"6b9f017e-cc80-4349-a948-e5418b4f0048","name":"Get Background Check Results By Subject's External ID","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/Subjects/getByExternalId/{{externalSystemId}}/backgroundCheckResults"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 20 Apr 2021 00:44:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\r\n \"initiated\": \"2020-11-24T00:51:58.634Z\",\r\n \"subjectId\": \"12367a18-2045-48f0-93f6-31aec3ce4eb1\",\r\n \"subjectExternalSystemId\": \"subjectExternalSystemId123\",\r\n \"riskMakeups\": [\r\n {\r\n \"riskName\": \"Political Speech\",\r\n \"count\": 51\r\n },\r\n {\r\n \"riskName\": \"Hate Speech\",\r\n \"count\": 0\r\n },\r\n {\r\n \"riskName\": \"Drug-related Images\",\r\n \"count\": 0\r\n },\r\n {\r\n \"riskName\": \"Explicit/Racy Images\",\r\n \"count\": 0\r\n },\r\n {\r\n \"riskName\": \"Violent Images\",\r\n \"count\": 0\r\n },\r\n {\r\n \"riskName\": \"Insults and Bullying\",\r\n \"count\": 8\r\n },\r\n {\r\n \"riskName\": \"Narcotics\",\r\n \"count\": 0\r\n },\r\n {\r\n \"riskName\": \"Obscene Language\",\r\n \"count\": 24\r\n },\r\n {\r\n \"riskName\": \"Self-Harm\",\r\n \"count\": 0\r\n },\r\n {\r\n \"riskName\": \"Toxic Language\",\r\n \"count\": 1\r\n },\r\n {\r\n \"riskName\": \"Threat of Violence\",\r\n \"count\": 0\r\n },\r\n {\r\n \"riskName\": \"Keywords\",\r\n \"count\": 30\r\n }\r\n ],\r\n \"channelVolumes\": [\r\n {\r\n \"channelName\": \"Facebook\",\r\n \"count\": 0\r\n },\r\n {\r\n \"channelName\": \"Twitter\",\r\n \"count\": 2226\r\n },\r\n {\r\n \"channelName\": \"Instagram\",\r\n \"count\": 0\r\n },\r\n {\r\n \"channelName\": \"LinkedIn\",\r\n \"count\": 0\r\n }\r\n ],\r\n \"flaggedPosts\": 84,\r\n \"totalPosts\": 2226,\r\n \"webSearchPosts\": 20,\r\n \"score\": 207,\r\n \"totalSentiment\": 78.3589,\r\n \"finishedScraping\": \"2020-11-24T00:59:55.5572882Z\",\r\n \"runStatus\": \"RunCompleted\"\r\n}"}],"_postman_id":"91abbfd3-b739-48c1-810d-8bf1526bd9e4"},{"name":"Download Background Report By SubjectId","id":"ed020620-e801-43a5-8170-486eac2be2ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/Subjects/{{subjectId}}/downloadBackgroundReport","description":"

Get the PDF file representing the background report for the subject.

Will return NotFound if the subject specified does not exist. Will return BadRequest if the subject does not have a completed background check.

Endpoints used to add, discover, and begin background checks for the organization's subjects.

\n","event":[{"listen":"prerequest","script":{"id":"581ef200-8ff8-46b6-a590-33b7e712b79b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9238e051-d705-44b0-923d-3371de38af0c","type":"text/javascript","exec":[""]}}],"_postman_id":"3f820ccf-9ccd-45b1-9900-36667b2e50e8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]},"isInherited":true,"source":{"_postman_id":"9d5543a4-164c-462e-a438-d4b544cc48fc","id":"9d5543a4-164c-462e-a438-d4b544cc48fc","name":"Ferretly External API","type":"collection"}}},{"name":"API Client Management","item":[{"name":"Get API Client Info","id":"92b9eb94-97a0-4e5a-8d7a-6d6c50f853d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/ApiClient","description":"

Get information about your API key

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
subscriberId	The id of the Ferretly user associated with the API key
organizationId	The id of the Ferretly organization associated with the API key
owner	A friendly name for the owner of the API key
permissions	A comma-separated list of permissions associated with the API key
statusUpdateCallbackUrl	The URL of a webhook which will be called when a subject's background check progress changes

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]},"isInherited":true,"source":{"_postman_id":"9d5543a4-164c-462e-a438-d4b544cc48fc","id":"9d5543a4-164c-462e-a438-d4b544cc48fc","name":"Ferretly External API","type":"collection"}},"urlObject":{"path":["ApiClient"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"27d6e2cf-961b-4236-b5bd-fc95dca7a19a","name":"Get API Client Info","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/ApiClient"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"subscriberId\": \"3633063d-d396-4c0c-ae8c-c850eb5a3df9\",\n \"organizationId\": \"6cca33ad-7c3e-4177-8d46-9367b6b20a65\",\n \"owner\": \"Ferretly\",\n \"permissions\": \"ManageSubjects\",\n \"statusUpdateCallbackUrl\": \"https://webook.example.com/status\"\n}"}],"_postman_id":"92b9eb94-97a0-4e5a-8d7a-6d6c50f853d6"},{"name":"Get API Client Organization","id":"63694c10-e8af-4cd9-9a45-5d2190386a0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/ApiClient/getOrganization","description":"

Gets the Ferretly Organization associated with the API key

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]},"isInherited":true,"source":{"_postman_id":"9d5543a4-164c-462e-a438-d4b544cc48fc","id":"9d5543a4-164c-462e-a438-d4b544cc48fc","name":"Ferretly External API","type":"collection"}},"urlObject":{"path":["ApiClient","getOrganization"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e677ce79-7cf0-406d-8ea4-2df10ae10af6","name":"Get API Client Organization","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/ApiClient/getOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 12 Dec 2020 18:27:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"563e7671-25da-49ca-82c6-88b28a7fd871\",\n \"name\": \"Ferretly International\",\n \"purchasedAnalystSupport\": true,\n \"affiliate_guid\": \"bdf770a2-65dd-42b3-98a7-439fd17fbf05\",\n \"affiliate\": {\n \"_id\": \"159c246c-2eda-4595-915c-533a5df5913d\",\n \"_owner\": \"bdf770a2-65dd-42b3-98a7-439fd17fbf05\",\n \"email\": \"info@ferretly.com\",\n \"status\": \"Reseller\",\n \"_createdDate\": \"2020-11-04T12:47:11.605Z\",\n \"_updatedDate\": \"2020-11-04T12:52:14.52Z\",\n \"companyName\": \"Ferretly International\",\n \"websiteAddress\": \"www.ferretly.com\",\n \"whitelabel\": true,\n \"logo\": \"https://www.ferretly.com/logo.png\",\n \"companyAddress\": null,\n \"companyAddress2\": null,\n \"companyCity\": null,\n \"companyPostalCode\": null,\n \"companyState\": null\n },\n \"credits_available\": 78,\n \"credits_used\": 107,\n \"stripe_customerId\": \"\",\n \"socialMediaScraperYears\": 7,\n \"planType\": \"Enterprise\",\n \"paymentMethod\": \"InApp\",\n \"isSubscriptionActive\": true,\n \"stripeSubscriptionId\": \"\",\n \"stripePlanId\": \"\",\n \"stripePricingId\": \"\"\n}"}],"_postman_id":"63694c10-e8af-4cd9-9a45-5d2190386a0f"},{"name":"Refresh/Replace API Key","event":[{"listen":"test","script":{"id":"6a44f7c0-be2f-45b9-8e97-eade6e29da29","type":"text/javascript","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"APIKey\", jsonData.apiKey);"]}}],"id":"951452fc-87f7-498a-a247-d10dd88f8c5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/ApiClient/refreshApiKey","description":"

Recreate your API key. Returns the new key along with your API client info.

Update the web hook (callback) URL associated with your API client. This URL will be used to notify your system of changes to the status of a subject's in-progress background check.

Endpoints to retrieve and update information about your API client.

\n","event":[{"listen":"prerequest","script":{"id":"33d956da-d127-4b1d-9dea-8c43ab7c0ef1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2ae85850-1893-4a72-a73c-ea81943a7eb0","type":"text/javascript","exec":[""]}}],"_postman_id":"c16216fd-1a9c-4ae6-9651-d04e6cd669cc","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]},"isInherited":true,"source":{"_postman_id":"9d5543a4-164c-462e-a438-d4b544cc48fc","id":"9d5543a4-164c-462e-a438-d4b544cc48fc","name":"Ferretly External API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{APIKey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"24cd2d75-7e6c-438f-852e-61204bf5de30","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"76339634-26b5-4064-80b7-47516f6e9886","type":"text/javascript","exec":[""]}}],"variable":[{"key":"{{APIKey}}","value":"","type":"any"},{"key":"{{subjectId}}","value":"","type":"any"},{"key":"{{URL}}","value":"","type":"any"}]}