Welcome to the GoLinks API! You can use this API to access our endpoints, such as the Golinks API to create golinks that you and everyone on your team can access. To access our API, you need to be on the GoLinks Enterprise plan. You can upgrade to the Enterprise plan by visiting the billing page. If you have any questions about the Enterprise plan, you can reach out to the Sales team.
\nThe GoLinks API uses access tokens to authenticate requests. The access token must be included in the Authorization header of your request. Any user on the Enterprise plan can create and revoke a token. Non-admins can only view and access their own tokens while admins can view and access all the tokens from their organization. Since any user can create a token, do not share your token with other users or include them in publicly accessible areas such as GitHub. If your token gets compromised, you can revoke that token and create a new one.
\nTo create an access token, sign in to your GoLinks account and go to the “Developers” tab in the \"Settings\" page. In the “API Tokens” panel, click on “Manage” and then click the “Create token” button.
\n![\"drawing\"](\"https://www.golinks.io/d/images/api-doc/empty-tokens-table.png\")
\n\nEnter a token name and click on the “Create token” button. Once the token gets created, you will be able to copy the token to your clipboard.
\n![\"drawing\"](\"https://www.golinks.io/d/images/api-doc/create-token-modal.png\")
\n\nYou should now see the new token information in the table. You are able to view the raw token anytime you need to, as well as edit the token name and revoke the token.
\n![\"drawing\"](\"https://www.golinks.io/d/images/api-doc/tokens-table.png\")
\n\nOnce you have created your access token, you can use it to make requests to the API. Requests are authenticated using HTTP Bearer Authentication. You must provide the access token in the Authorization header:
\nAuthorization: Bearer {ACCESS_TOKEN}\n\nIf you do not provide an access token or your access token is no longer active, you will receive an error message with a 401 status code.
\n{\n \"error\": {\n \"message\": \"The API token is not valid or is deactivated.\",\n \"code\": 401,\n \"type\": \"not_authorized\"\n }\n}\n\nThe GoLinks API is REST-based and uses standard HTTP verbs and status codes. The API accepts form-encoded request bodies and returns JSON-encoded responses. All requests should be made over SSL.
\nThe base URL to access the GoLinks API is https://api.golinks.io. For example, to access the golinks endpoint, just add the endpoint to the base URL: https://api.golinks.io/golinks.
\nAll responses from the API will include a standard HTTP successful or error status code. The successful status codes are as follows:
\nFor errors, we include extra information as to why the request was not successful. The error response body will have the following format:
\n{\n \"error\": {\n \"message\": \"Descriptive information about the error\",\n \"code\": \"HTTP error code\",\n \"type\": \"Type of error returned\"\n }\n}\n\nFor example, if you try to create a golink that already exists, you will get the following error response:
\n{\n \"error\": {\n \"message\": \"The golink go/git already exists. Please use another name for the golink.\",\n \"code\": 409,\n \"type\": \"conflict\"\n }\n}\n\nThe error status codes, along with their error types, are as follows:
\nA rate limit is enforced for every endpoint and is based on the user's IP address. We currently allow 100 writes per minute and 150 reads per minute. If you exceed the rate limit, you will receive a 429 status code with the following error body:
\n{\n \"error\": {\n \"message\": \"API rate limit exceeded. Please try again in 60 seconds.\",\n \"code\": 429,\n \"type\": \"rate_limit_exceeded\"\n }\n}\n\nEvery request contains information about the rate limit in the HTTP response headers.
\nAll the endpoints that return a list come with a metadata object that contains pagination information. We return a default of 50 results per page and use the limit and offset parameters to determine the number of results to return and the number of results to skip. You can fetch the next set of results through the URL that is provided in metadata.links.next. If there are no more results, then the value will be null.
\nThe metadata object will include the following parameters. The dot notation denotes a child attribute.
\nIf you will be running the following requests in Postman, you can add your Access token to the Pre-request Script or create a new environment variable named token and set the value to be your access token.
\n// Add your access token below\npostman.setEnvironmentVariable(\"token\", \"\");\n\nIf you have any questions about the API or are running into errors, please reach out to support@golinks.io.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"API Overview","slug":"api-overview"},{"content":"Setup for Postman","slug":"setup-for-postman"},{"content":"Support","slug":"support"}],"owner":"10666283","collectionId":"cb29b458-6059-4d42-bfd0-1d8c1466acda","publishedId":"TVzVjGcy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00a3e7"},"publishDate":"2021-01-19T17:36:45.000Z"},"item":[{"name":"Golinks","item":[{"name":"Create a golink","event":[{"listen":"prerequest","script":{"id":"6fa5cd50-1d23-49f2-98fd-f0a31936b826","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a19f2706-fcf1-459c-9e4a-fc075bc8c7c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"uid","value":"484371","description":"(Optional) Create a golink for another user using their UID. If the 'uid' is not set in the request body, the golink will be created for the token owner.
\n","type":"text"},{"description":"(Required) The destination URL.
\n","key":"url","type":"text","value":"https://drive.google.com/drive/"},{"description":"(Required) The link name.
\n","key":"name","type":"text","value":"drive"},{"description":"(Required) Brief description of the link.
\n","key":"description","type":"text","value":"Company shared Google Drive"},{"description":"(Optional) Organize your golinks and find the right ones quickly with tags.
\n","key":"tags[]","type":"text","value":"drive"},{"description":"(Optional) If the value is 1, the link is unlisted, so only you and the people you’ve shared it with can use it. Set the value to 0 to share it with everyone in your organization.
\n","key":"unlisted","type":"text","value":"0"},{"key":"private","value":"0","description":"(Optional) If the value is 1, the link is private, so only you can see and use it. Links cannot change to or from private after creation.
\n","type":"text"},{"key":"public","value":"0","description":"(Optional) If the value is 1, the link can be accessed by people outside of your organization.
\n","type":"text"},{"key":"format","value":"0","description":"(Optional) If the value is 1, invalid characters (e.g. punctuation) will be removed from the created go link name
\n","type":"text"},{"key":"hyphens","value":"0","description":"(Optional, requires Format to be ‘1’) If the value is 1, spaces will be replaced with hyphens in the go link name. If the value is 0, spaces will be removed.
\n","type":"text"},{"key":"aliases[]","value":"drive-alias","description":"(Optional) Easily create multiple names for the same link with aliases. In this array, specify the name(s) of the aliases as strings, this call will throw an error if any of the provided names are already taken by any existing links or aliases.
\n","type":"text"},{"key":"geolinks[0][location]","value":"US","description":"(Optional) Create different destinations for a link depending on current location with geo links. This must be an array of objects containing \"location\" and \"url\" keys representing the mappings of user locations to the link they will be redirected to, the default mapping will be any other locations than the ones specified by the objects in this array, and the main url of this link. The \"location\" must be a valid two-character ISO code for a country, or \"US-\" followed by the two-character code for a state (for state-localized links for the US only). ISO codes: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes\nState-localized codes: https://en.wikipedia.org/wiki/ISO_3166-2:US
\n","type":"text"},{"key":"geolinks[0][url]","value":"https://drive.google.com/drive/US","description":"(Optional) Create different destinations for a link depending on current location with geo links. This must be an array of objects containing \"location\" and \"url\" keys representing the mappings of user locations to the link they will be redirected to, the default mapping will be any other locations than the ones specified by the objects in this array, and the main url of this link. The \"url\" key must be a valid url.
\n","type":"text"},{"key":"geolinks[1][location]","value":"US-CA","description":"(Optional) State-localized geo link for the US state of California.
\n","type":"text"},{"key":"geolinks[1][url]","value":"https://drive.google.com/drive/California","description":"(Optional) State-localized geo link for the US state of California.
\n","type":"text"}]},"url":"https://api.golinks.io/golinks","description":"Create a new golink. You can view the newly created golink in your dashboard: https://app.golinks.io?filter=new
\n","urlObject":{"protocol":"https","path":["golinks"],"host":["api","golinks","io"],"query":[],"variable":[]}},"response":[{"id":"3bea13c6-d401-4a24-a88e-599154b5e3c3","name":"Golink already exists","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"uid","value":"484371","description":"(Optional) Create a golink for another user using their UID. If the 'uid' is not set in the request body, the golink will be created for the token owner.","type":"text"},{"description":"(Required) The destination URL.","key":"url","type":"text","value":"https://drive.google.com/drive/"},{"description":"(Required) The link name.","key":"name","type":"text","value":"drive"},{"description":"(Required) Brief description of the link.","key":"description","type":"text","value":"Company shared Google Drive"},{"description":"(Optional) Organize your golinks and find the right ones quickly with tags.","key":"tags[]","type":"text","value":"drive"},{"description":"(Optional) If the value is 1, the link is private so only you and the people you’ve shared it with can use it. Set the value to 0 to share it with everyone in your organization.","key":"unlisted","type":"text","value":"0"}]},"url":"https://api.golinks.io/golinks"},"code":409,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"The golink go/drive already exists. Please use another name for the golink.\",\n \"code\": 409,\n \"type\": \"conflict\"\n }\n}"},{"id":"6b210d17-6f8f-44a6-bceb-32d1af141895","name":"Create a golink","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"uid","value":"484371","type":"text"},{"description":"The destination URL.","key":"url","type":"text","value":"https://drive.google.com/drive/"},{"description":"The link name.","key":"name","type":"text","value":"drive"},{"description":"Brief description of the link.","key":"description","type":"text","value":"Company shared Google Drive"},{"description":"Organize your golinks and find the right ones quickly with tags.","key":"tags[]","type":"text","value":"drive"},{"description":"Make the link private so only you and people you’ve shared with can use.","key":"unlisted","type":"text","value":"0"}]},"url":"https://api.golinks.io/golinks"},"code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"gid\": 12130,\n \"cid\": 12,\n \"user\": {\n \"uid\": 484371,\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"username\": \"test.user\",\n \"email\": \"test.user@golinks.io\",\n \"user_image_url\": \"https://www.gravatar.com/avatar/94d093eda664addd6e450d7e9881bcad?s=32&d=identicon&s=200&r=pg\"\n },\n \"url\": \"https://drive.google.com/drive/\",\n \"name\": \"drive\",\n \"description\": \"Company shared Google Drive\",\n \"tags\": [\n {\n \"tid\": 79,\n \"name\": \"drive\"\n }\n ],\n \"unlisted\": 0,\n \"variable_link\": 0,\n \"pinned\": 0, \n \"created_at\": 1576577874,\n \"updated_at\": 1576577874\n}"}],"_postman_id":"a19f2706-fcf1-459c-9e4a-fc075bc8c7c1"},{"name":"Edit a golink","event":[{"listen":"prerequest","script":{"id":"787c3687-e66e-4ce9-ad56-5df86cfc0c12","exec":[""],"type":"text/javascript","packages":{}}}],"id":"96320952-8d38-4ee5-aa80-903ce92f5bdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"gid","value":"12345678","description":"(Required) The id of the golink to edit.
\n","type":"text"},{"key":"action","value":"pin","description":"(Optional) If the value is 'pin', the pinned status of the golink will be updated to the value specified by the 'pinned' field. If the value is 'lock', the locked status of the golink will be updated to the value specified by the 'locked' field. If this field is set to either of these values, the other updates (url, name, tags, etc.) will be ignored.
\n","type":"text"},{"key":"pinned","value":"0","description":"(Required if action = 'pin') If the value is 1, the link will be pinned, otherwise, it will be unpinned.
\n","type":"text"},{"key":"locked","value":"0","description":"(Required if action = 'lock') If the value is 1, the link will be locked, otherwise, it will be unlocked.
\n","type":"text"},{"key":"url","value":"https://drive.google.com/drive/","description":"(Required if 'action' not specified) The updated destination URL.
\n","type":"text"},{"key":"name","value":"drive","description":"(Required if 'action' not specified) The updated link name.
\n","type":"text"},{"key":"description","value":"Company shared Google Drive","description":"(Required if 'action' not specified) The updated description of the link.
\n","type":"text"},{"key":"tags[]","value":"drive","description":"(Optional) The updated tag set. Warning: the golink's tag set will be updated to what is sent in this request, if you want to maintain the current set of tags, you must send them in this request. Specifying no tags will result in all tags being removed.
\n","type":"text"},{"key":"unlisted","value":"0","description":"(Optional) If the value is 1, the link is unlisted, so only you and the people you’ve shared it with can use it. Set the value to 0 to share it with everyone in your organization.
\n","type":"text"},{"key":"public","value":"0","description":"(Optional) If the value is 1, the link can be accessed by people outside of your organization.
\n","type":"text"},{"key":"aliases[]","value":"drive-alias","description":"(Optional) The updated alias set. Warning: the golink's aliases will be updated to what is sent in this request, if you want to maintain the current set of aliases, you must send them in this request. Specifying no aliases will result in all aliases being deleted.
\n","type":"text"},{"key":"geolinks[0][location]","value":"US","description":"(Optional) The updated geolink set. Warning: the golink's geolinks will be updated to what is sent in this request, if you want to maintain the current set of geolinks, you must send them in this request. Specifying no geolinks will result in all geolink mappings being deleted. ISO codes: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
\n","type":"text"},{"key":"geolinks[0][url]","value":"https://drive.google.com/drive/US","description":"(Optional) The updated geolink set. Warning: the golink's geolinks will be updated to what is sent in this request, if you want to maintain the current set of geolinks, you must send them in this request. Specifying no geolinks will result in all geolink mappings being deleted.
\n","type":"text"},{"key":"geolinks[1][location]","value":"US-CA","description":"(Optional) State-localized geo link for the US state of California.
\n","type":"text"},{"key":"geolinks[1][url]","value":"https://drive.google.com/drive/California","description":"(Optional) State-localized geo link for the US state of California.
\n","type":"text"}]},"url":"https://api.golinks.io/golinks","description":"Modify an existing golink.
\n","urlObject":{"protocol":"https","path":["golinks"],"host":["api","golinks","io"],"query":[],"variable":[]}},"response":[{"id":"748de691-3312-4bfa-9f4a-59da8b3fc377","name":"Edit a golink","originalRequest":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"gid","value":"12345678","description":"(Required) The id of the golink to edit.","type":"text"},{"key":"url","value":"https://drive.google.com/drive/folder","description":"(Required if 'action' not specified) The updated destination URL.","type":"text"},{"key":"name","value":"drive","description":"(Required if 'action' not specified) The updated link name.","type":"text"},{"key":"description","value":"Company shared Google Drive folder","description":"(Required if 'action' not specified) The updated description of the link.","type":"text"}]},"url":"https://api.golinks.io/golinks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"},{"id":"27b130e7-b3e8-4271-ad00-2016d6affbec","name":"Pin a golink","originalRequest":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"gid","value":"12345678","description":"(Required) The id of the golink to edit.","type":"text"},{"key":"action","value":"pin","description":"(Optional) If the value is 'pin', the pinned status of the golink will be updated to the value specified by the 'pinned' field. If the value is 'lock', the locked status of the golink will be updated to the value specified by the 'locked' field. If this field is set to either of these values, other updates will be ignored.","type":"text"},{"key":"pinned","value":"1","description":"(Required if action = 'pin') If the value is 1, the link will be pinned, otherwise, it will be unpinned.","type":"text"}]},"url":"https://api.golinks.io/golinks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"pinned\": \"1\"\n}"},{"id":"39eccf57-c536-444b-a9b1-f50480cef78c","name":"Lock a golink","originalRequest":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"gid","value":"12345678","description":"(Required) The id of the golink to edit.","type":"text"},{"key":"action","value":"lock","description":"(Optional) If the value is 'pin', the pinned status of the golink will be updated to the value specified by the 'pinned' field. If the value is 'lock', the locked status of the golink will be updated to the value specified by the 'locked' field. If this field is set to either of these values, other updates will be ignored.","type":"text"},{"key":"locked","value":"1","description":"(Required if action = 'lock') If the value is 1, the link will be locked, otherwise, it will be unlocked.","type":"text"}]},"url":"https://api.golinks.io/golinks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"locked\": \"1\"\n}"}],"_postman_id":"96320952-8d38-4ee5-aa80-903ce92f5bdd"},{"name":"Delete a golink","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"b9a303b3-dc76-4ee1-84a7-1b6d2d235f38"}}],"id":"bff8acee-5cfb-44f0-853a-515ff8d5f4a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.golinks.io/golinks?gid=12345678","description":"Delete an existing golink.
\n","urlObject":{"protocol":"https","path":["golinks"],"host":["api","golinks","io"],"query":[{"description":{"content":"(Required) The id of the golink to delete.
\n","type":"text/plain"},"key":"gid","value":"12345678"}],"variable":[]}},"response":[{"id":"b1344cc6-5dd8-4b54-b93c-9c4bd8171cd6","name":"Delete a golink","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.golinks.io/golinks?gid=12345678","protocol":"https","host":["api","golinks","io"],"path":["golinks"],"query":[{"key":"gid","value":"12345678","description":"(Required) The id of the golink to delete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"bff8acee-5cfb-44f0-853a-515ff8d5f4a2"},{"name":"List all golinks","id":"2e20ad1d-fe03-473e-8a46-a001572c624a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"https://api.golinks.io/golinks?limit={{limit}}&offset={{offset}}&sort=","description":"Retrieve all the golinks from your organization. The golinks are sorted by the redirect hits, with the highest daily redirect golink appearing at the top. If there are any pinned links, they will appear first on the list and will be sorted by the golink creation date.
\nYou can also return the golinks sorted by their creation date, with the most recent golink created appearing at the top, by passing in the query param sort with the value created_at (e.g. https://api.golinks.io?sort=created_at).
(Optional) The number of results to return per page, between 1-100. Defaults to 50.
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"(Optional) The number of results to skip. Defaults to 0.
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"},{"description":{"content":"(Optional) If the value is \"created_at\", golinks will be sorted by order of creation, with the newest golinks first. Otherwise, the default sorting is top used this week
\n","type":"text/plain"},"key":"sort","value":""}],"variable":[]}},"response":[{"id":"0a0962cf-9357-4e99-ae1e-7d90e47c36f6","name":"List all golinks","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.golinks.io/golinks"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"limit\": 50,\n \"offset\": 0,\n \"count\": 50,\n \"total_results\": 400,\n \"links\": {\n \"prev\": null,\n \"next\": \"https://api.golinks.io/golinks?limit=50&offset=50\"\n }\n },\n \"results\": [\n {\n \"gid\": 12130,\n \"cid\": 12,\n \"user\": {\n \"uid\": 484371,\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"username\": \"test.user\",\n \"email\": \"test.user@golinks.io\",\n \"user_image_url\": \"https://www.gravatar.com/avatar/94d093eda664addd6e450d7e9881bcad?s=32&d=identicon&s=200&r=pg\"\n },\n \"url\": \"https://drive.google.com/drive/\",\n \"name\": \"drive\",\n \"description\": \"Company shared Google Drive\",\n \"tags\": [\n {\n \"tid\": 79,\n \"name\": \"drive\"\n }\n ],\n \"unlisted\": 0,\n \"variable_link\": 0,\n \"pinned\": 0,\n \"redirect_hits\": {\n \"daily\": 100,\n \"weekly\": 100,\n \"monthly\": 100,\n \"alltime\": 100\n },\n \"created_at\": 1576577874,\n \"updated_at\": 1576577874\n },\n {...}\n ]\n}\n"}],"_postman_id":"2e20ad1d-fe03-473e-8a46-a001572c624a"},{"name":"Retrieve a golink","event":[{"listen":"prerequest","script":{"id":"87d0acdd-0675-48c2-abf2-016ac5213636","exec":[""],"type":"text/javascript"}}],"id":"bc35cbc8-2424-438a-985f-c37cb69add7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"https://api.golinks.io/golinks/{{gid}}","description":"Retrieve the details of a single golink using the golink ID. You can also retrieve the details using the golink name by passing in the query parameter name (e.g. https://api.golinks.io/golinks?name=drive).
The Golinks API lets you retrieve and create golinks that can be shared with everyone in your organization or can be used for private use.
\nThe golinks object will include the following parameters. The dot notation denotes a child attribute.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"8751244d-b1eb-46a7-b87d-c3b26e7e9253","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b229ac16-8d23-42cc-a12f-709e4e054dea","type":"text/javascript","exec":[""]}}],"_postman_id":"19f87188-f2fb-4b75-bf69-83f0c0ca5029"},{"name":"Metrics","item":[{"name":"Retrieve the metrics for the daily redirect hits","id":"1dfe7bac-0045-4281-a06f-d6f74e9dc98c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"https://api.golinks.io/metrics/{{gid}}","description":"Retrieve the daily redirect hits for a golink for the last 30 days. If the golink has not been used in the last 30 days, the redirect hits will be 0.
\n","urlObject":{"protocol":"https","path":["metrics","{{gid}}"],"host":["api","golinks","io"],"query":[],"variable":[]}},"response":[{"id":"eb8f7218-bb08-4002-a9e2-1605c3001e26","name":"Retrieve the metrics for the daily redirect hits","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.golinks.io/metrics/12130"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"gid\": 12130,\n \"name\": \"drive\",\n \"metrics\": [\n {\n \"date\": 1609315200,\n \"hits\": 0\n },\n {\n \"date\": 1609401600,\n \"hits\": 1\n },\n {\n \"date\": 1609488000,\n \"hits\": 3\n },\n {...}\n ]\n}"}],"_postman_id":"1dfe7bac-0045-4281-a06f-d6f74e9dc98c"}],"id":"114b6ee1-f03e-4659-963c-12d3b2ebcce2","description":"The Metrics API lets you retrieve the metrics for all the golinks in your organization, such as the daily redirect hits for the last 30 days.
\nThe metrics object will include the following parameters.
\nThe metrics array contains objects with the following attributes:
\n","_postman_id":"114b6ee1-f03e-4659-963c-12d3b2ebcce2"},{"name":"Users","item":[{"name":"List all users","event":[{"listen":"prerequest","script":{"id":"53f94a98-1658-43ce-a812-1f9adac0a6bc","exec":[""],"type":"text/javascript"}}],"id":"bb642b92-5b7b-42c9-82d8-4f42396fa37d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"https://api.golinks.io/users?limit={{limit}}&offset={{offset}}","description":"Retrieve all the users from your organization.
\n","urlObject":{"protocol":"https","path":["users"],"host":["api","golinks","io"],"query":[{"description":{"content":"(Optional) The number of results to return per page, between 1-100. Defaults to 50.
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"(Optional) The number of results to skip. Defaults to 0.
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"}],"variable":[]}},"response":[{"id":"130c2355-5077-4a3e-a9f4-5b74063b4d47","name":"List all users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.golinks.io/users"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"limit\": 50,\n \"offset\": 0,\n \"count\": 50,\n \"total_results\": 130,\n \"links\": {\n \"prev\": null,\n \"next\": \"https://api.golinks.io/users?limit=50&offset=50\"\n }\n },\n \"results\": [\n {\n \"uid\": 484371,\n \"cid\": 12,\n \"ualid\": 2,\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"username\": \"test.user\",\n \"email\": \"test.user@golinks.io\",\n \"user_image_url\": \"https://www.gravatar.com/avatar/94d093eda664addd6e450d7e9881bcad?s=32&d=identicon&s=200&r=pg\",\n \"role\": \"engineering\",\n \"admin\": 1,\n \"active\": 1,\n \"created_at\": 1556320857,\n \"updated_at\": 1556320857\n },\n {...}\n ]\n}"}],"_postman_id":"bb642b92-5b7b-42c9-82d8-4f42396fa37d"},{"name":"Search for users","event":[{"listen":"test","script":{"id":"3005ff5a-918b-4126-a035-42d56cee9b98","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"e4aae7c6-3530-4aae-b960-7a1813ec85b2","exec":[""],"type":"text/javascript"}}],"id":"e033037a-2e4a-475d-863c-5a3aa7c6d7fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"https://api.golinks.io/users?search={{search}}&access-level={{access-level}}","description":"Search for a specific user using their email, name or username or search for users that match a filter, such as retrieve all users that have a certain domain. Narrow down the users you want to retrieve by setting the access-level query parameter to only return admins or members or setting the status query parameter to only return active or inactive users.
\n","urlObject":{"protocol":"https","path":["users"],"host":["api","golinks","io"],"query":[{"description":{"content":"The search term that matches on name and email.
\n","type":"text/plain"},"key":"search","value":"{{search}}"},{"description":{"content":"(Optional) If set to “admin”, shows admins only.
\n","type":"text/plain"},"key":"access-level","value":"{{access-level}}"},{"disabled":true,"description":{"content":"(Optional) The status of the user: active or inactive.
\n","type":"text/plain"},"key":"status","value":"{{status}}"}],"variable":[]}},"response":[{"id":"7cc02dcc-290d-45a6-802c-272c344eee59","name":"Search for a user","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://api.golinks.io/users?search=test.user@golinks.io","protocol":"https","host":["api","golinks","io"],"path":["users"],"query":[{"key":"search","value":"test.user@golinks.io","description":"Search for a specific user or users that match the search filter."}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"metadata\": {\n \"limit\": 50,\n \"offset\": 0,\n \"count\": 1,\n \"total_results\": 1,\n \"links\": {\n \"prev\": null,\n \"next\": null\n }\n },\n \"results\": [\n {\n \"uid\": 484371,\n \"cid\": 12,\n \"ualid\": 2,\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"username\": \"test.user\",\n \"email\": \"test.user@golinks.io\",\n \"user_image_url\": \"https://www.gravatar.com/avatar/94d093eda664addd6e450d7e9881bcad?s=32&d=identicon&s=200&r=pg\",\n \"role\": \"engineering\",\n \"admin\": 1,\n \"active\": 1,\n \"created_at\": 1556320857,\n \"updated_at\": 1556320857\n }\n ]\n}"}],"_postman_id":"e033037a-2e4a-475d-863c-5a3aa7c6d7fb"}],"id":"1d67b801-4d64-4e21-8e3d-e378675b0764","description":"The Users API lets you retrieve information regarding all the users in your organization. You can search for users with a certain access-level or status and also search for a specific user using their email or name.
\nThe user's object will include the following parameters. The dot notation denotes a child attribute.
\n","_postman_id":"1d67b801-4d64-4e21-8e3d-e378675b0764"}],"event":[{"listen":"prerequest","script":{"id":"f18a95ba-03b0-4921-a237-3e5286c28a94","type":"text/javascript","exec":["// Add your access token below","postman.setEnvironmentVariable(\"token\", \"e017a89e3aa4b420324dafd2ead92f86732f588c79b48444c14c3272a36672ce\");",""]}},{"listen":"test","script":{"id":"792b0b52-2326-4a94-9a63-976fca45ca15","type":"text/javascript","exec":[""]}}],"variable":[{"key":"auth","value":""}]}