required
\n","type":"text/plain"},"key":"grant_type","value":"password"},{"description":{"content":"required
\n","type":"text/plain"},"key":"email","value":"Foo@bar.com"},{"description":{"content":"required
\n","type":"text/plain"},"key":"password","value":"Foo@Bar!123"},{"description":{"content":"required
\n","type":"text/plain"},"key":"client_id","value":"1234545-dsfggfsd"},{"description":{"content":"required
\n","type":"text/plain"},"key":"client_secret","value":"adsf-asdff"},{"description":{"content":"required
\n","type":"text/plain"},"key":"scope","value":"write_external_users read_external_users read_pass_books"},{"description":{"content":"required
\n","type":"text/plain"},"key":"museum_id","value":"123"}],"variable":[]}},"response":[],"_postman_id":"50b717cb-a005-4474-955b-2fc0fa8f721f"}],"id":"491b48b4-fe85-405d-a9f8-05156b4154c2","_postman_id":"491b48b4-fe85-405d-a9f8-05156b4154c2","description":""},{"name":"External users","item":[{"name":"Create an external user","id":"010dd81d-73a1-449f-8de9-644b37ecf1d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Create a new external user record.
\nFor the authorization, you should use a token generated by the Authenticate method.
\n","urlObject":{"protocol":"https","path":["api","v5","external_users"],"host":["app","cuseum","com"],"query":[{"description":{"content":"Required
\n","type":"text/plain"},"key":"external_id","value":"1234455"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"name","value":"foo@bar.com"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"email_address","value":"foo"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"membership_level","value":"Gold"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"expiration","value":""},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"address","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"city","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"state","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"postal_code","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"phone_number","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"barcode","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"join_date","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"member_number","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"secondary_email","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"secondary_member_number","value":null},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"custom_field","value":null}],"variable":[]}},"response":[{"id":"15ea0552-f66a-4b82-bfbb-bdc840d35165","name":"Success - response example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://app.cuseum.com/api/v5/external_users?external_id=1234455&name=foo@bar.com&email_address=foo&membership_level=Gold&expiration=&address=&city=&state=&postal_code=&phone_number=&barcode=&join_date=&member_number=&secondary_email=&secondary_member_number=&custom_field=","protocol":"https","host":["app","cuseum","com"],"path":["api","v5","external_users"],"query":[{"key":"external_id","value":"1234455","description":"Required","type":"text"},{"key":"name","value":"foo@bar.com","description":"Required","type":"text"},{"key":"email_address","value":"foo","description":"Required","type":"text"},{"key":"membership_level","value":"Gold","description":"Required","type":"text"},{"key":"expiration","value":"","description":"Optional","type":"text"},{"key":"address","value":"","description":"Optional","type":"text"},{"key":"city","value":"","description":"Optional","type":"text"},{"key":"state","value":"","description":"Optional","type":"text"},{"key":"postal_code","value":"","description":"Optional","type":"text"},{"key":"phone_number","value":"","description":"Optional","type":"text"},{"key":"barcode","value":"","description":"Optional","type":"text"},{"key":"join_date","value":"","description":"Optional","type":"text"},{"key":"member_number","value":"","description":"Optional","type":"text"},{"key":"secondary_email","value":"","description":"Optional","type":"text"},{"key":"secondary_member_number","value":"","description":"Optional","type":"text"},{"key":"custom_field","value":"","description":"Optional","type":"text"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Mar 2025 18:38:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"205"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"12f46c21c90c3f65fbe73dc35f0867ac\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"font-src 'self' https: data:; object-src 'none'; img-src 'self' https: data: cdn.mxpnl.com s3.amazonaws.com; script-src 'self' https: 'unsafe-inline' 'unsafe-eval' load.sumome.com connect.facebook.net www.googletagmanager.com; style-src 'self' https: 'unsafe-inline' fonts.googleapis.com; default-src 'self' https: ws: wss: sumo.com www.google-analytics.com bam.nr-data.net s3.amazonaws.com"},{"key":"X-Request-Id","value":"b299b362-ad89-4c38-8f6d-34bb3ea5c565"},{"key":"X-Runtime","value":"0.050602"},{"key":"X-Powered-By","value":"cloud66"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 11506368,\n \"name\": \"foo@bar.com\",\n \"address\": null,\n \"city\": null,\n \"state\": null,\n \"postal_code\": null,\n \"phone_number\": null,\n \"email_address\": \"foo\",\n \"photo\": {\n \"url\": null,\n \"content_type\": null\n },\n \"photo_url\": null,\n \"expires_at\": null,\n \"membership_level\": \"Gold\",\n \"loyalty_points\": 0,\n \"monthly_loyalty_points\": 0,\n \"monthly_loyalty_actions\": 0,\n \"custom_field\": null\n}"},{"id":"3846fe57-b254-4879-acc7-250e889495a8","name":"Missing fields - response example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://app.cuseum.com/api/v5/external_users?external_id&name&email_address&membership_level&address&city","protocol":"https","host":["app","cuseum","com"],"path":["api","v5","external_users"],"query":[{"key":"external_id","value":null,"description":"Required"},{"key":"name","value":null,"description":"Required"},{"key":"email_address","value":null,"description":"Required"},{"key":"membership_level","value":null,"description":"Required"},{"key":"address","value":null,"description":"Optional"},{"key":"city","value":null,"description":"Optional"}]}},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Mar 2025 18:20:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Security-Policy","value":"font-src 'self' https: data:; object-src 'none'; img-src 'self' https: data: cdn.mxpnl.com s3.amazonaws.com; script-src 'self' https: 'unsafe-inline' 'unsafe-eval' load.sumome.com connect.facebook.net www.googletagmanager.com; style-src 'self' https: 'unsafe-inline' fonts.googleapis.com; default-src 'self' https: ws: wss: sumo.com www.google-analytics.com bam.nr-data.net s3.amazonaws.com"},{"key":"X-Request-Id","value":"54e9fd53-a691-47b0-8c43-e32c39c81ee2"},{"key":"X-Runtime","value":"0.059655"}],"cookie":[],"responseTime":null,"body":"{\n \"full_error_messages\": [\n \"Email address can't be blank\"\n ],\n \"errors\": {\n \"email_address\": [\n \"can't be blank\"\n ]\n }\n}"},{"id":"67c21258-35eb-417d-9f13-df35a40c4c16","name":"Invalid token - response example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://app.cuseum.com/api/v5/external_users?external_id&name&email_address&membership_level&address&city","protocol":"https","host":["app","cuseum","com"],"path":["api","v5","external_users"],"query":[{"key":"external_id","value":null,"description":"Required"},{"key":"name","value":null,"description":"Required"},{"key":"email_address","value":null,"description":"Required"},{"key":"membership_level","value":null,"description":"Required"},{"key":"address","value":null,"description":"Optional"},{"key":"city","value":null,"description":"Optional"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Mar 2025 16:41:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Security-Policy","value":"font-src 'self' https: data:; object-src 'none'; img-src 'self' https: data: cdn.mxpnl.com s3.amazonaws.com; script-src 'self' https: 'unsafe-inline' 'unsafe-eval' load.sumome.com connect.facebook.net www.googletagmanager.com; style-src 'self' https: 'unsafe-inline' fonts.googleapis.com; default-src 'self' https: ws: wss: sumo.com www.google-analytics.com bam.nr-data.net s3.amazonaws.com"},{"key":"X-Request-Id","value":"0c6c6aba-a972-440d-b07a-1785e00b496e"},{"key":"X-Runtime","value":"0.010268"}],"cookie":[],"responseTime":null,"body":"{\n \"full_error_messages\": \"The access token is invalid\"\n}"}],"_postman_id":"010dd81d-73a1-449f-8de9-644b37ecf1d9"},{"name":"Update an external user","id":"96980c63-f870-4990-b2b9-4abbb4116357","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Return all external users in batches of 25 records per page, in the response headers you can found the total records and the total pages.
\n","urlObject":{"protocol":"https","path":["api","v5","external_users"],"host":["app","cuseum","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f279f83-8e6c-4b6f-b8eb-836353a8b004"},{"name":"External users next page","id":"9656fd3a-dc42-4c42-b207-a1402672b5a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"https://app.cuseum.com/api/v5/external_users?page=2","description":"Return the next 25 external users.
\n","urlObject":{"protocol":"https","path":["api","v5","external_users"],"host":["app","cuseum","com"],"query":[{"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"67ff7478-fb59-41e5-942f-c249cc0c53cb","name":"External users page 2","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.cuseum.com/api/v5/external_users?page=2","protocol":"https","host":["app","cuseum","com"],"path":["api","v5","external_users"],"query":[{"key":"page","value":"2"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9656fd3a-dc42-4c42-b207-a1402672b5a1"},{"name":"External users next page","id":"171afe1f-515a-45fe-a872-0de5b5376dcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"https://app.cuseum.com/api/v5/external_users?page=2","urlObject":{"protocol":"https","path":["api","v5","external_users"],"host":["app","cuseum","com"],"query":[{"key":"page","value":"2"}],"variable":[]}},"response":[],"_postman_id":"171afe1f-515a-45fe-a872-0de5b5376dcf"}],"id":"6a61d9bc-60da-480f-a6e6-6b01fea84522","_postman_id":"6a61d9bc-60da-480f-a6e6-6b01fea84522","description":""},{"name":"Webhooks","item":[{"name":"Send webhook","id":"d09756d9-103f-4904-b228-3a90e6321b73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"external_id\":\"8447\",\n \"name\":\"Foo Bar\",\n \"email_address\":\"foobar55@gmail.com\",\n \"membership_level\":\"General\",\n \"expiration\":\"2024-10-31 23:59:59\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://app.cuseum.com/dm/integrations/general/receive","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"webhook_key"},{"key":"value","value":"Return all Pass Books in batches of 25 records per page, in the response headers you can found the total records and the total pages.
\n","urlObject":{"protocol":"https","path":["api","v5","pass_books"],"host":["app","cuseum","com"],"query":[{"disabled":true,"description":{"content":"Status of the passbook
\n","type":"text/plain"},"key":"f[status_eq]","value":"uninstalled"},{"disabled":true,"description":{"content":"Filter by updated_at field using =
\n","type":"text/plain"},"key":"f[updated_at_eq]","value":"Thu, 15 May 2026 00:00:00.000000000 UTC +00:00"},{"disabled":true,"description":{"content":"Filter by updated_at field using >=
\n","type":"text/plain"},"key":"f[updated_at_gteq]","value":"Thu, 15 May 2026 00:00:00.000000000 UTC +00:00"},{"disabled":true,"description":{"content":"Filter by updated_at field using <=
\n","type":"text/plain"},"key":"f[updated_at_lteq]","value":"Thu, 15 May 2026 00:00:00.000000000 UTC +00:00"},{"disabled":true,"description":{"content":"Filter by created_at field using =
\n","type":"text/plain"},"key":"f[created_at_eq]","value":"Thu, 15 May 2026 00:00:00.000000000 UTC +00:00"},{"disabled":true,"description":{"content":"Filter by created_at field using >=
\n","type":"text/plain"},"key":"f[created_at_gteq]","value":"Thu, 15 May 2026 00:00:00.000000000 UTC +00:00"},{"disabled":true,"description":{"content":"Filter by created_at field using <=
\n","type":"text/plain"},"key":"f[created_at_lteq]","value":"Thu, 15 May 2026 00:00:00.000000000 UTC +00:00"},{"disabled":true,"key":"f[external_user_external_id_eq]","value":"12345"},{"disabled":true,"key":"page","value":"2"}],"variable":[]}},"response":[],"_postman_id":"dc4979e2-3d14-48e4-acd4-b5a55593fd14"}],"id":"5c036c54-9cab-4dd1-ba8c-a5c1f5b7d670","_postman_id":"5c036c54-9cab-4dd1-ba8c-a5c1f5b7d670","description":""}],"variable":[{"key":"Oauth token ","value":"CSS"}]}