Resource search
A resource search returns results for a single resource type, which is useful when you need to return the full resource or expand attributes within the result. If you do not need to return the full resource, consider using the top-level search endpoint to limit the data returned.
Search Endpoints
- GET /api/v2/groups/search
- POST /api/v2/groups/search
- GET /api/v2/users/search
- POST /api/v2/users/search
- GET /api/v2/locations/search
- POST /api/v2/locations/search
Request Format
You can expand results with the users resource. Valid values include:
- authorization
- conversationSummary
- geolocation
- outOfOffice
- presence
- routingStatus
- station
Example Resource Searches
User Search By Partial Last Name
Run this search in API Explorer
Copied
{
"pageSize": 25,
"pageNumber": 1,
"query": [{
"type": "CONTAINS",
"fields": ["name"],
"value": "Smith"
}]
}Copied
{
"total": 16,
"pageCount": 1,
"pageSize": 25,
"pageNumber": 1,
"currentPage": "/api/v2/users/search?q64=H4sIAAAAAAAAAD2NTQuCQBiE_8ucvRR02VuIYpeN2u0QEbLlmy64Yru-gYn_PT-g4zzzMDOg61sKEDdwIB9wj_Bm8v1EhqWDQHyUen-QChFelupi0RvjaLY_puZZUs52FcaJtKYkZb8T3O7WJNk9yENsInjq2Dfpf6ZkW8wzgYx_Vno9PF2S8zXXWSLzNNFxhvEHln4mE6gAAAA%3D",
"types": [
"users"
],
"results": [
{
"id": "99676c3d-4433-4c6d-8e8a-6c49652d9733",
"name": "Smith, Matt",
"chat": {
"jabberId": "524b23656c2fdb575c2b9afe@inin.orgspan.com"
},
"department": "PSO Application Development",
"email": "Matt.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13179571494",
"display": "+1 317-957-1494",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "+15745141870",
"mediaType": "SMS",
"type": "PRIMARY"
},
{
"address": "Matt.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+15745141870",
"display": "+1 574-514-1870",
"mediaType": "SMS",
"type": "MOBILE"
},
{
"address": "+13179571494",
"display": "+1 317-957-1494",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "Team Lead, Software Engineering",
"username": "Matt.Smith@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/ae5b6cfc/5993/4479/b074/9357fa801ce9.jpg"
},
{
"resolution": "x128",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/c4682737/f614/4e97/bd09/5565f4ac758f.jpg"
},
{
"resolution": "x200",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/820b5268/1787/491e/b08e/6e1c494a8f97.jpg"
},
{
"resolution": "x48",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/8d5842ed/3752/4ad1/a06b/e8186f6491ab.jpg"
},
{
"resolution": "x300",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/67b689ab/5534/48ac/aee4/3da49fb6c24a.jpg"
},
{
"resolution": "x400",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/26cbfba4/f0ef/49f8/90e9/c5b09eed2c1d.jpg"
}
],
"version": 1439,
"selfUri": "/api/v2/users/99676c3d-4433-4c6d-8e8a-6c49652d9733"
},
{
"id": "06cafa78-17ab-4a4a-9719-895beb5581d7",
"name": "Smith, Crockett",
"chat": {
"jabberId": "531db04d74800353e628ae51@inin.orgspan.com"
},
"department": "Information Technology",
"email": "Crockett.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13174934050",
"display": "+1 317-493-4050",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "+17653660853",
"mediaType": "SMS",
"type": "PRIMARY"
},
{
"address": "Crockett.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+17653660853",
"display": "+1 765-366-0853",
"mediaType": "SMS",
"type": "MOBILE"
},
{
"address": "+17653660853",
"display": "+1 765-366-0853",
"mediaType": "PHONE",
"type": "HOME"
},
{
"address": "+13174934050",
"display": "+1 317-493-4050",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "System Support Specialist",
"username": "Crockett.Smith@inin.com",
"version": 156,
"selfUri": "/api/v2/users/06cafa78-17ab-4a4a-9719-895beb5581d7"
},
{
"id": "40fabb4c-134a-471e-af1b-600120c83c0d",
"name": "Smith-Guerrero, Mark",
"chat": {
"jabberId": "5654904aa025251a7c8e44bd@inin.orgspan.com"
},
"department": "Development",
"email": "Mark.Smith-Guerrero@inin.com",
"primaryContactInfo": [
{
"address": "+13174934002",
"display": "+1 317-493-4002",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "Mark.Smith-Guerrero@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+13174934002",
"display": "+1 317-493-4002",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "Sr Software Engineer",
"username": "Mark.Smith-Guerrero@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/40183fa7/ddbe/4ecd/b2e2/0c4c9c72e1cd.jpg"
},
{
"resolution": "x128",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/a719d8e1/ebcc/4319/bd97/8a165d38a201.jpg"
},
{
"resolution": "x200",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/d261cbbe/9fd4/437f/b277/36f967a6ded3.jpg"
},
{
"resolution": "x48",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/743aa423/505b/45ab/962d/6516f828389a.jpg"
},
{
"resolution": "x300",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/e467ac80/a5a7/44f9/91e8/1a7343a7f17c.jpg"
},
{
"resolution": "x400",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/afa6785c/e487/491c/aae8/75588709c992.jpg"
}
],
"version": 8,
"selfUri": "/api/v2/users/40fabb4c-134a-471e-af1b-600120c83c0d"
},
{
"id": "cb7dc41c-287f-4824-8b5a-92e4db4e2c2d",
"name": "Smith, Andy",
"chat": {
"jabberId": "5457b8fc0070f30cf34791ed@inin.orgspan.com"
},
"department": "Documentation",
"email": "Andy.Smith@inin.com",
"primaryContactInfo": [
{
"address": "Andy.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [],
"state": "active",
"title": "Technical Communicator",
"username": "Andy.Smith@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/989f59e6/d671/48e1/aa64/b8ce9f8cefea.jpg"
},
{
"resolution": "x128",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/88853b59/1466/4522/a9f4/f4ec0e01635a.jpg"
},
{
"resolution": "x200",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/d0d806a2/8d7c/459a/8e8c/fff0d1ef3d8d.jpg"
},
{
"resolution": "x48",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/0594900b/b71d/46ea/a618/195a7a13e386.jpg"
},
{
"resolution": "x300",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/623c2fc5/2138/4fc6/a1f7/06823c705e83.jpg"
},
{
"resolution": "x400",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/8f2dcbaf/15c9/4680/9157/3ac0f10ba76e.jpg"
}
],
"version": 248,
"selfUri": "/api/v2/users/cb7dc41c-287f-4824-8b5a-92e4db4e2c2d"
},
{
"id": "692abaee-a94b-468f-aad9-2b22818afee9",
"name": "Smith, Andrea",
"chat": {
"jabberId": "524b22fd6c2fdb575c2b9804@inin.orgspan.com"
},
"department": "Engagement Management",
"email": "Andrea.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13179571773",
"display": "+1 317-957-1773",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "Andrea.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+13179571773",
"display": "+1 317-957-1773",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "PSO - Consultant",
"username": "Andrea.Smith@inin.com",
"version": 1211,
"selfUri": "/api/v2/users/692abaee-a94b-468f-aad9-2b22818afee9"
},
{
"id": "8bec57d5-091d-41e8-854c-a6cf0def19f7",
"name": "Smith, Justin",
"chat": {
"jabberId": "5252c6df6c2fdb245de5b72b@inin.orgspan.com"
},
"department": "Support Services",
"email": "Justin.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13179571753",
"display": "+1 317-957-1753",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "+17657488898",
"mediaType": "SMS",
"type": "PRIMARY"
},
{
"address": "Justin.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+17657488898",
"display": "+1 765-748-8898",
"mediaType": "SMS",
"type": "MOBILE"
},
{
"address": "+13179571753",
"display": "+1 317-957-1753",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "Sr System Engineer",
"username": "Justin.Smith@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/ac48fbe7/f950/4f6b/a54a/1656c987cb3c.jpg"
},
{
"resolution": "x128",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/52d62392/751f/4884/abfe/2fc7cd09778b.jpg"
},
{
"resolution": "x200",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/9c9b3fd0/a88e/49e5/b50c/035ceb79cdd0.jpg"
},
{
"resolution": "x48",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/944c0288/31aa/4148/b62b/29fc6694201a.jpg"
},
{
"resolution": "x300",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/7a98b913/3721/4989/a72d/6de186bc9517.jpg"
},
{
"resolution": "x400",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/853cbedc/e696/4b87/899c/23951eb0cce3.jpg"
}
],
"version": 1288,
"selfUri": "/api/v2/users/8bec57d5-091d-41e8-854c-a6cf0def19f7"
},
{
"id": "0d793b56-ecd7-4a6d-8491-04f1126f8fb1",
"name": "Smith, Chris",
"chat": {
"jabberId": "52c1a5176c2fdb3d92983ccc@inin.orgspan.com"
},
"department": "Information Technology",
"email": "Chris.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13179571680",
"display": "+1 317-957-1680",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "+13179704124",
"mediaType": "SMS",
"type": "PRIMARY"
},
{
"address": "Chris.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+13179704124",
"display": "+1 317-970-4124",
"mediaType": "SMS",
"type": "MOBILE"
},
{
"address": "+13179704124",
"display": "+1 317-970-4124",
"mediaType": "PHONE",
"type": "HOME"
},
{
"address": "+13179571680",
"display": "+1 317-957-1680",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "Associate IT Operations Engineer, Network",
"username": "Chris.Smith@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/b7535ff3/9206/4b0a/a90e/3952dd901ccf.jpg"
},
{
"resolution": "x128",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/01816173/291a/4a04/872e/bc731987d825.jpg"
},
{
"resolution": "x200",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/a17a38f2/9714/488a/b31c/34854a66ab8a.jpg"
},
{
"resolution": "x48",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/37cfe675/5227/432a/9628/d82a197389c9.jpg"
},
{
"resolution": "x300",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/fa61d442/a111/4f33/b5b0/bc6b7ed1def5.jpg"
},
{
"resolution": "x400",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/b0adc701/d0db/4e2c/9161/d674374478bb.jpg"
}
],
"version": 1251,
"selfUri": "/api/v2/users/0d793b56-ecd7-4a6d-8491-04f1126f8fb1"
},
{
"id": "318a8d49-e449-4c8b-bad9-1c41093fd89e",
"name": "Smith Major",
"chat": {
"jabberId": "569c52ff9b89741991f47771@inin.orgspan.com"
},
"email": "a.major42@yahoo.com",
"primaryContactInfo": [
{
"address": "a.major42@yahoo.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [],
"state": "active",
"username": "a.major42@yahoo.com",
"version": 6,
"selfUri": "/api/v2/users/318a8d49-e449-4c8b-bad9-1c41093fd89e"
},
{
"id": "5b45296f-ace7-4025-91c5-fa47123de800",
"name": "Smith, Parker",
"chat": {
"jabberId": "524b1df76c2fdb575c2b75fa@inin.orgspan.com"
},
"department": "CIC Applications",
"email": "Parker.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13174934042",
"display": "+1 317-493-4042",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "+13176946153",
"mediaType": "SMS",
"type": "PRIMARY"
},
{
"address": "Parker.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+13176946153",
"display": "+1 317-694-6153",
"mediaType": "SMS",
"type": "MOBILE"
},
{
"address": "+13174934042",
"display": "+1 317-493-4042",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "Software Engineer",
"username": "Parker.Smith@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/a454fe2a/a386/440b/bd7e/3d20839df6ed.jpg"
},
{
"resolution": "x128",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/f6d898cb/ead3/45e9/a4bc/e63a1a0fed22.jpg"
},
{
"resolution": "x200",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/5b97d6af/53b4/4dd7/95b6/c5daa670fb8d.jpg"
},
{
"resolution": "x48",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/c7e3e313/b20d/41e9/b94d/01031fd00d1b.jpg"
},
{
"resolution": "x300",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/85c1b87c/d5d3/45ec/89b9/5e27a20a5746.jpg"
},
{
"resolution": "x400",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/84909caa/562a/40c1/ac4a/b4515b10aae6.jpg"
}
],
"version": 1438,
"selfUri": "/api/v2/users/5b45296f-ace7-4025-91c5-fa47123de800"
},
{
"id": "ad716ab8-c75e-417b-898e-af66273872d8",
"name": "Smith, Tim",
"chat": {
"jabberId": "524b1f6a6c2fdb575c2b7f71@inin.orgspan.com"
},
"department": "Development",
"email": "Tim.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13177158561",
"display": "+1 317-715-8561",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "+13179876873",
"mediaType": "SMS",
"type": "PRIMARY"
},
{
"address": "Tim.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+13177158561",
"display": "+1 317-715-8561",
"mediaType": "PHONE",
"type": "WORK"
},
{
"address": "+13179876873",
"display": "+1 317-987-6873",
"mediaType": "SMS",
"type": "MOBILE"
},
{
"address": "+13038401769",
"display": "+1 303-840-1769",
"mediaType": "PHONE",
"type": "HOME"
}
],
"state": "active",
"title": "Sr Technical Integrations Specialist",
"username": "Tim.Smith@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/a259761e/5089/4e87/835f/49de0670d50e.jpg"
},
{
"resolution": "x128",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/0d8711c7/4ecd/4314/8831/d7913ade1001.jpg"
},
{
"resolution": "x200",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/b0c269bc/c71d/4198/985b/db5e5a47375f.jpg"
},
{
"resolution": "x48",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/fa7d409f/6ec6/497a/be8c/232c5ef21ec6.jpg"
},
{
"resolution": "x300",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/731c6267/00f2/493d/9460/8ff9cfda2f59.jpg"
},
{
"resolution": "x400",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/a513704b/88d5/4fa6/84d8/6176304e5d11.jpg"
}
],
"version": 1484,
"selfUri": "/api/v2/users/ad716ab8-c75e-417b-898e-af66273872d8"
},
{
"id": "21feb62e-b816-45c3-a71f-8cac781ca1f0",
"name": "Smith, Anthony",
"chat": {
"jabberId": "524b22d66c2fdb575c2b96f4@inin.orgspan.com"
},
"department": "DEV Development",
"email": "Anthony.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13174934662",
"display": "+1 317-493-4662",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "Anthony.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+13174934662",
"display": "+1 317-493-4662",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "Associate Software Engineer",
"username": "Anthony.Smith@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://d1v4lthfmnlw3h.cloudfront.net/0ba07462/40c0/4feb/8cf3/9a47783dc8d7.jpg"
},
{
"resolution": "x128",
"imageUri": "https://d1v4lthfmnlw3h.cloudfront.net/b3314ebd/2a62/4812/8328/7bf7803267f6.jpg"
},
{
"resolution": "x200",
"imageUri": "https://d1v4lthfmnlw3h.cloudfront.net/351d3d65/a573/4cd9/a5ee/21650f0a59f3.jpg"
},
{
"resolution": "x48",
"imageUri": "https://d1v4lthfmnlw3h.cloudfront.net/30c2b579/7d2d/4ca2/be38/11ef7537fc68.jpg"
},
{
"resolution": "x300",
"imageUri": "https://d1v4lthfmnlw3h.cloudfront.net/60046ce0/9c70/43d0/9d6f/2a1c12f26145.jpg"
},
{
"resolution": "x400",
"imageUri": "https://d1v4lthfmnlw3h.cloudfront.net/701605e4/baba/4837/a447/9b0848dd199e.jpg"
}
],
"version": 1440,
"selfUri": "/api/v2/users/21feb62e-b816-45c3-a71f-8cac781ca1f0"
},
{
"id": "d3eec346-a539-4def-962f-5ed1f460e33f",
"name": "Smith, Rj",
"chat": {
"jabberId": "565490122434c318178f7112@inin.orgspan.com"
},
"department": "Professional Services Org",
"email": "Rj.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13179576399",
"display": "+1 317-957-6399",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "+18126065331",
"mediaType": "SMS",
"type": "PRIMARY"
},
{
"address": "Rj.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+18126065331",
"display": "+1 812-606-5331",
"mediaType": "SMS",
"type": "MOBILE"
},
{
"address": "+13179576399",
"display": "+1 317-957-6399",
"mediaType": "PHONE",
"type": "WORK"
}
],
"state": "active",
"title": "Sr Genesys Cloud Enablement Lead",
"username": "Rj.Smith@inin.com",
"images": [
{
"resolution": "x96",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/076f6252/777a/4034/bf1f/27bbe5a7f4ce.jpg"
},
{
"resolution": "x128",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/24100deb/62fc/4a02/bce4/47b44eb6a92e.jpg"
},
{
"resolution": "x200",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/70ade4e8/25cc/4dc6/89f4/e264e0f8021a.jpg"
},
{
"resolution": "x48",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/7e018e80/58d5/494b/b73a/0d763dfe6c46.jpg"
},
{
"resolution": "x300",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/02a1c629/9f74/456e/a0b8/ee3fb99d959b.jpg"
},
{
"resolution": "x400",
"imageUri": "https://dev-inin-directory-service-profile.s3.amazonaws.com/de22cb45/5fa5/49a4/aae1/d028a16509b7.jpg"
}
],
"version": 9,
"selfUri": "/api/v2/users/d3eec346-a539-4def-962f-5ed1f460e33f"
},
{
"id": "18f7ca3c-31a5-404c-8d79-eb41cff99bf9",
"name": "Test Smith",
"chat": {
"jabberId": "541c79b31b4d4619934004b1@inin.orgspan.com"
},
"department": "Marketing",
"email": "tim.smith@timsdesign.com",
"primaryContactInfo": [
{
"address": "tim.smith@timsdesign.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [],
"state": "active",
"title": "Test Account",
"username": "tim.smith@timsdesign.com",
"version": 9,
"selfUri": "/api/v2/users/18f7ca3c-31a5-404c-8d79-eb41cff99bf9"
},
{
"id": "7b634a63-cff6-4392-8ffc-e9bc1811917f",
"name": "Smith, Joe",
"chat": {
"jabberId": "524b24de6c2fdb575c2ba5bf@inin.orgspan.com"
},
"department": "Testing",
"email": "joe.Smith@inin.com",
"primaryContactInfo": [
{
"address": "+13172222222",
"display": "+13172222222",
"mediaType": "PHONE",
"type": "PRIMARY"
},
{
"address": "+13172222222",
"mediaType": "SMS",
"type": "PRIMARY"
},
{
"address": "Joe.Smith@inin.com",
"mediaType": "EMAIL",
"type": "PRIMARY"
}
],
"addresses": [
{
"address": "+13172222222",
"display": "+13172222222",
"mediaType": "SMS",
"type": "MOBILE"
}
],
"state": "active",
"title": "System Architect",
"username": "Joe.Smith@inin.com",
"version": 1252,
"selfUri": "/api/v2/users/7b634a63-cff6-4392-8ffc-e9bc1811917f"
}
]
}Search users by partial email
The following example returns users whose email begins with Tom.Smith (prior to the @ symbol).
Run this search in API Explorer
Copied
{
"pageSize": 25,
"pageNumber": 1,
"query": [{
"type": "TERM",
"fields": ["email"],
"value": "tom.smith"
}]
}Groups search by exact name.
Run this search in API Explorer
Copied
{
"pageSize": 25,
"pageNumber": 1,
"query": [{
"type": "EXACT",
"fields": ["name"],
"value": "Demo Group"
}]
}Copied
{
"total": 1,
"pageCount": 1,
"pageSize": 25,
"pageNumber": 1,
"currentPage": "/api/v2/groups/search?q64=H4sIAAAAAAAAAD2NSwuCQBSF_8tZz6agjbuQEVdCNUIRIVPeTPAx3fEGJv73fEDL852PcwZ0vSOP4IqCW3EeN4W3EPcTGpYSAfR5HxooPEuq8kVubE2z-rGVzIYX51ruME7M2YJO5XfC292aEqnvxAg2CkydcBP9hwop83nIk-XHy6x_h1QfL5mJdZJF2oQxxh94DrDRqAAAAA%3D%3D",
"types": [
"groups"
],
"results": [
{
"id": "c6fc6f57-4c1e-4812-980a-5154f500b5c6",
"name": "Support",
"dateModified": "2016-04-30T07:47:58Z",
"memberCount": 27,
"state": "active",
"version": 108,
"selfUri": "/api/v2/groups/c6fc6f57-4c1e-4812-980a-5154f500b5c6"
}
]
}Groups search by partial name
Run this search in API Explorer
Copied
{
"pageSize": 25,
"pageNumber": 1,
"query": [{
"type": "CONTAINS",
"fields": ["name"],
"value": "demo"
}]
}Search locations based on partial name
Run this search in API Explorer
Copied
{
"pageSize": 25,
"pageNumber": 1,
"query": [{
"type": "STARTS_WITH",
"fields": ["name"],
"value": "Ind"
}]
}Copied
{
"total": 1,
"pageCount": 1,
"pageSize": 25,
"pageNumber": 1,
"currentPage": "/api/v2/locations/search?q64=H4sIAAAAAAAAAD2NTQuCMBzGv8tz9lLQxVuIMi9CbhERIcv9s8GcNl1g4nfPF-j4_J63Ef3QUofwBtOUsteN7XAP8PbkhpmOq48QXBxzwYtLKhgCPDUZtbasrGkpfKTxSy61CtOsW1kR198Z7Q-bynz9IIdwF8BR751N_iOV12oZ6Ui68iW2x9M5zq-FYHFWJLGIGKYfAwKR_60AAAA%3D",
"types": [
"locations"
],
"results": [
{
"id": "2e7ed8bf-be71-4c36-90bc-b1288e93e6e2",
"name": "Indianapolis, IN",
"address": {
"city": "Indianapolis",
"country": "US",
"countryName": "United States",
"state": "IN",
"street1": "7601 Interactive Way",
"zipcode": "47278"
},
"addressVerified": true,
"emergencyNumber": {
"e164": "+13172222222",
"number": "+1 317-222-2222",
"type": "default"
},
"state": "active",
"version": 4,
"selfUri": "/api/v2/locations/2e7ed8bf-be71-4c36-90bc-b1288e93e6e2"
}
]
}